Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-265759203.4 KB
Workflow

Run Workflow

Start a workflow run and return a job ID for tracking.

Supports per-run spec overrides via specs_override and webhook input via webhook_payload. API-triggered read_csv workflows must provide specs_override.resource_handle_id from /storage/csv/upload.

post/workflows/run

Query parameters

workflow_idstring required

Workflow ID to run

Workflow ID to run

save_jsonboolean

Also save results as JSON

Also save results as JSON

result_formatsstring[] nullable

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

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

Headers

x-api-keystring nullable

Request body

specs_overrideobject nullable

Optional specs to override first block specs

Response

Successful Response

statusstring required

Run status, typically 'queued'.

workflow_idstring required

Workflow identifier.

job_idstring required

Job (run) identifier.

cache_configobject nullable

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

already_startedboolean nullable

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