Skip to main content
POST
Run Workflow

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Headers

Idempotency-Key
string

A key you generate. A retry with the same key returns the run already started instead of starting and charging a second one.

Maximum string length: 255

Query Parameters

workflow_id
string
required

Workflow ID to run

Maximum string length: 200
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.

Maximum string length: 200

Body

application/json

Run options. workflow_id, save_json and result_formats are query parameters.

specs_override
Specs Override · object | null

Overrides for the source block's specs on this run, such as resource_handle_id for a read_csv source.

expected_revision
integer | null

Run only if the workflow's edit_revision still equals this value.

Required range: x >= 0
webhook_payload
object

Response

Successful Response

Response when a workflow run is started.

status
string
required

RUNNING, or queued while the start is still being confirmed. An Idempotency-Key replay returns the run's current status.

workflow_id
string
required

Workflow identifier.

job_id
string
required

Job (run) identifier.

already_started
boolean | null

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