Autenticación
Todas las solicitudes a la API requieren una clave de API pasada en el encabezadox-api-key:
API de registros
Todas las respuestas de la API incluyen información sobre tus límites de ejecución de flujos de trabajo y su uso:X-RateLimit-*).
Consultar registros
Consulta los registros de ejecución de flujos de trabajo con amplias opciones de filtrado.- Tab Title
- Tab Title
workspaceId- Tu ID de espacio de trabajo
workflowIds- IDs de flujos de trabajo separados por comasfolderIds- IDs de carpetas separados por comastriggers- Tipos de disparadores separados por comas:api,webhook,schedule,manual,chatlevel- Filtrar por nivel:info,errorstartDate- Marca de tiempo ISO para el inicio del rango de fechasendDate- Marca de tiempo ISO para el fin del rango de fechasexecutionId- Coincidencia exacta de ID de ejecuciónminDurationMs- Duración mínima de ejecución en milisegundosmaxDurationMs- Duración máxima de ejecución en milisegundosminCost- Costo mínimo de ejecuciónmaxCost- Costo máximo de ejecuciónmodel- Filtrar por modelo de IA utilizado
limit- Resultados por página (predeterminado: 100)cursor- Cursor para la siguiente páginaorder- Orden de clasificación:desc,asc(predeterminado: desc)
details- Nivel de detalle de la respuesta:basic,full(predeterminado: básico)includeTraceSpans- Incluir intervalos de seguimiento (predeterminado: falso)includeFinalOutput- Incluir salida final (predeterminado: falso)
Obtener detalles del registro
Recupera información detallada sobre una entrada de registro específica.- Tab Title
- Tab Title
Obtener detalles de ejecución
Recupera detalles de ejecución incluyendo la instantánea del estado del flujo de trabajo.- Tab Title
- Tab Title
Suscripciones a webhooks
Recibe notificaciones en tiempo real cuando se completan las ejecuciones de flujos de trabajo. Los webhooks se configuran a través de la interfaz de usuario de Aurora Workflow.en el editor de flujos de trabajo.Configuración
Los webhooks pueden configurarse para cada flujo de trabajo a través de la interfaz de usuario del editor de flujos de trabajo. Haz clic en el icono de webhook en la barra de control para configurar tus suscripciones a webhooks. Opciones de configuración disponibles:url: URL del punto final de tu webhooksecret: Secreto opcional para verificación de firma HMACincludeFinalOutput: Incluir la salida final del flujo de trabajo en la carga útilincludeTraceSpans: Incluir intervalos de seguimiento de ejecución detalladosincludeRateLimits: Incluir información del límite de tasa del propietario del flujo de trabajoincludeUsageData: Incluir datos de uso y facturación del propietario del flujo de trabajolevelFilter: Array de niveles de registro a recibir (info,error)triggerFilter: Array de tipos de disparadores a recibir (api,webhook,schedule,manual,chat)active: Habilitar/deshabilitar la suscripción al webhook
Carga útil del webhook
Cuando se completa la ejecución de un flujo de trabajo, Aurora Workflow.envía una solicitud POST a tu URL de webhook:Cabeceras de webhook
Cada solicitud de webhook incluye estas cabeceras:sim-event: Tipo de evento (siempreworkflow.execution.completed)sim-timestamp: Marca de tiempo Unix en milisegundossim-delivery-id: ID único de entrega para idempotenciasim-signature: Firma HMAC-SHA256 para verificación (si se configura un secreto)Idempotency-Key: Igual que el ID de entrega para detección de duplicados
Verificación de firma
Si configuras un secreto de webhook, verifica la firma para asegurar que el webhook proviene de Sim:- Tab Title
- Tab Title
Política de reintentos
Las entregas de webhook fallidas se reintentan con retroceso exponencial y fluctuación:- Máximo de intentos: 5
- Retrasos de reintento: 5 segundos, 15 segundos, 1 minuto, 3 minutos, 10 minutos
- Fluctuación: Hasta un 10% de retraso adicional para prevenir el efecto de manada
- Solo las respuestas HTTP 5xx y 429 activan reintentos
- Las entregas agotan el tiempo de espera después de 30 segundos
Las entregas de webhook se procesan de forma asíncrona y no afectan al
rendimiento de ejecución del flujo de trabajo.
Mejores prácticas
-
Estrategia de sondeo: Al sondear registros, utiliza paginación basada en cursor con
order=ascystartDatepara obtener nuevos registros de manera eficiente. - Seguridad de webhook: Siempre configura un secreto de webhook y verifica las firmas para asegurar que las solicitudes provienen de Aurora Workflow.
-
Idempotencia: Utiliza la cabecera
Idempotency-Keypara detectar y manejar entregas duplicadas de webhook. -
Privacidad: Por defecto,
finalOutputytraceSpansestán excluidos de las respuestas. Habilítalos solo si necesitas los datos y comprendes las implicaciones de privacidad. -
Limitación de tasa: Implementa retroceso exponencial cuando recibas respuestas 429. Consulta la cabecera
Retry-Afterpara conocer el tiempo de espera recomendado.
Limitación de tasa
La API implementa limitación de tasa para garantizar un uso justo:- Plan gratuito: 10 solicitudes por minuto
- Plan Pro: 30 solicitudes por minuto
- Plan Team: 60 solicitudes por minuto
- Plan Enterprise: Límites personalizados
X-RateLimit-Limit: Máximo de solicitudes por ventanaX-RateLimit-Remaining: Solicitudes restantes en la ventana actualX-RateLimit-Reset: Marca de tiempo ISO cuando se reinicia la ventana
