Workflows

Ejecutar un workflow

Encola una ejecución del workflow, como el botón "Run" de la interfaz, y devuelve su identificador y el estado con el que nace (queued).

POST
/api/v1/workflows/{workflowId}/runs

Ejemplos de petición

curl https://app.filmo.io/api/v1/workflows/work_8f2a1c/runs \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "payload": {
    "numeroPedido": "P-2026-0042"
  }
}'
{
  "data": {
    "runId": "run_9f3a2b",
    "state": "queued"
  }
}

Generado a partir del esquema

Envía tu propia Idempotency-Key

Un reintento sin la misma clave duplica el efecto. Envía tu propia Idempotency-Key y sigue la tabla de reintentos.

No espera a que termine, y la API aún no tiene ninguna operación que lea una ejecución: su progreso solo se ve en la aplicación de Filmo. Si el workflow declara un formulario de ejecución, sus campos son obligatorios y viajan en payload; si falta alguno responde 400 sin encolar nada. Un workflow sin ninguna versión guardada responde 409. Acepta Idempotency-Key: dos peticiones con la misma clave devuelven la misma ejecución en lugar de encolar dos.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. workflows:run

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

Parámetros de ruta

workflowIdstringObligatorio

Identificador del workflow que se ejecutará.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: WorkflowRunCreateBody

payloadobject<string, any>

Valores del formulario de ejecución del workflow, por nombre de campo. Si el workflow declara campos, son OBLIGATORIOS y se validan contra su versión publicada: si falta alguno, la petición responde 400 y no se encola nada. Si no declara ninguno, se ignora.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: WorkflowRunCreatedDto

Sobre: WorkflowRunCreatedResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Acuse de una ejecución en cola.

Mostrar atributos hijos
data.runIdstring

Identificador de la ejecución en cola.

data.statestring

Estado inicial de la ejecución. Cuando acaba de encolarse es queued.

Opciones disponibles: queued, running, waiting, paused, completed, failed, cancelled

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones