Skip to main content
POST
Run Workflow

Headers

x-api-key
string | null

Query Parameters

workflow_id
string
required

Workflow ID to run

save_json
boolean
default:false

Also save results as JSON

result_formats
string[] | null

Result formats to save. Repeat the parameter for multiple values, e.g. result_formats=csv&result_formats=ndjson.

Body

application/json
specs_override
Specs Override · object | null

Optional specs to override first block specs

webhook_payload
object

Response

Successful Response

Response when a workflow run is started.

status
string
required

Run status, typically 'queued'.

workflow_id
string
required

Workflow identifier.

job_id
string
required

Job (run) identifier.

cache_config
Cache Config · object | null

Cache configuration; only set by the custom-cache endpoint.

already_started
boolean | null

True when the request was deduplicated via Idempotency-Key header.