Skip to main content
Use the Workflows API after you publish an event-to-call workflow in the dashboard. These routes start and control runs. They do not create or edit the graph. Every request requires a workspace API key in the X-API-Key header. Use the workflow run scope to start, cancel, or wake a run. Add workflow read to check status. The API key determines the workspace, so these paths do not include a workspace ID.

Start a run

POST /v1/workflows/{workflowId}/run — queue a published workflow with context.

Get run status

GET /v1/workflows/{workflowId}/runs/{runId} — inspect status, context, and output.

Cancel a run

POST /v1/workflows/{workflowId}/runs/{runId}/cancel — stop one active run.

Cancel runs

POST /v1/workflows/{workflowId}/runs/cancel — stop runs by concurrency key, or all of them.

Wake waiting runs

POST /v1/workflows/{workflowId}/runs/wake — continue runs sleeping at a wait step.
Publish the workflow first. Drafts reject start requests. Reuse Idempotency-Key when you retry the same start. Add Concurrency-Key when only one active run should exist for a store, ticket, or similar key.