Endpoints
Run a Workflow
This endpoint initiates the execution of a workflow, and returns the workflow run ID.
POST
/
v2
/
runs
This endpoint initiates a workflow run asynchronously. It returns a workflow run id
immediately and does not wait for completion.
To monitor the workflow’s progress and get results, use the Get Workflow Run endpoint with the returned id
. A common pattern is to poll this endpoint periodically until the workflow completes.
Authorizations
X-Api-Key
string
headerrequiredBody
application/json
workflow_id
string
requiredThe ID of the workflow to be run.
trigger_id
string
The ID of the node to start the workflow with.
webhook_url
string
The URL to which the workflow results should be sent to on completion.
input
object
Variables that the workflow can use globally and their values.
Response
200 - application/json
id
string
requiredversion_id
string
requiredworkflow_id
string
requiredstatus
enum<string>
requiredAvailable options:
completed
, running
, failed
, queued
, cancelled
created_at
string
requirederror
string | null
requiredresult
object | null
required