Flow

Run a flow

POST
/flows/{flow}:run

Triggers an asynchronous execution and returns immediately with the execution resource name. Connect to the SSE stream to track progress.

BearerAuth
headerAuthorizationBearer <JWT>

Admin token, API token issued via /api-tokens, or an OIDC JWT access token issued by the configured OIDC provider.

flow*string
Formatuuid
application/json
  1. body

Per-run options. The whole body may be omitted for a plain run.

trace?boolean

Collect 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.

Defaultfalse

Response Body

Execution accepted.

application/json
  1. response
name*string

Unique resource name of the created execution.

Example Request
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"}