Run a flow
POST
Triggers an asynchronous execution and returns immediately with the execution resource name. Connect to the SSE stream to track progress.
BearerAuthheader
AuthorizationBearer <JWT>Admin token, API token issued via /api-tokens, or an OIDC JWT access token issued by the configured OIDC provider.
flow*stringFormat
uuidapplication/json- body
Per-run options. The whole body may be omitted for a plain run.
trace?booleanCollect a line-level execution trace. The flow's own source is instrumented for the run, which slows it down, and the resulting artifact is stored for later download via GET /flows/{flow}/executions/{execution}/trace. Defaults to false.
Default
falseExecution accepted.
application/json- response
name*stringUnique resource name of the created execution.
curl -X POST 'https://example.com/api/hub/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08:run' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "name": "flows/550e8400-e29b-41d4-a716-446655440000/executions/660e8400-e29b-41d4-a716-446655440000"}