Skip to main content
POST
Create Sync Run
This endpoint creates and waits for a workflow run to complete before returning the result. It blocks until the run reaches a terminal state or the request times out (120 seconds max). For long-running workflows, use the async run endpoint with SSE streaming or a callback_url instead.

Parameters

Path Parameters

string
required
The ID of the workflow to run.

Query Parameters

boolean
default:"false"
When true, the response contains only the workflow output (not the full run object). Useful when you only need the result.
boolean
default:"false"
When true, output keys use node IDs instead of human-readable labels.

Body Parameters

object
required
Key-value pairs mapping input node labels (or IDs) to their values. The keys depend on how your workflow’s input nodes are configured.
string
Optional webhook URL. Even though this is a synchronous endpoint, you can still receive a webhook callback when the run completes. Must be a valid HTTP(S) URL — invalid URLs are rejected with a 422 at creation time.
string (uuid)
Run a specific saved version of the workflow. If omitted, the latest (current) version is used.
string[]
Limit execution to a subset of node IDs. Only these nodes (and their dependencies) will run. If omitted, the full workflow runs.
string
Run a single node in isolation. The provided input must satisfy all of the node’s input requirements.
boolean
default:"false"
Enable OpenTelemetry tracing for this run. Traces are sent to your configured observability provider.
string
Override the workspace (group) for this run. Defaults to the workspace associated with the API key.
string
Debugger session ID for live debugging in the workflow editor.

Examples

Basic synchronous run

Output only

Returns just the workflow output without the full run metadata:

Run a specific version

Authorizations

X-API-Key
string
header
required

Path Parameters

workflow_id
string
required

Query Parameters

output_only
boolean
default:false
use_output_ids
boolean
default:false

Body

application/json
input
Input · object
required
node_ids
string[] | null
single_node_id
string | null
group_id
string | null
workflow_version_id
string<uuid> | null
tracing
boolean
default:false
debugger
string | null
callback_url
string<uri> | null
Required string length: 1 - 2083

Response

Successful Response

id
string<uuid>
required
output
Output · object
required