Endpoints
Run a Workflow
This endpoint initiates the execution of a workflow, and returns the workflow run ID.
POST
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
Body
application/json
The ID of the workflow to be run.
Example:
"wkfv2_bZNg4zPR44mA"
The ID of the node to start the workflow with.
Example:
"ncc6725"
The URL to which the workflow results should be sent to on completion.
Example:
"https://myapp.com/webhook"
Variables that the workflow can use globally and their values.
Example:
{
"first_name": "Sam",
"last_name": "Altman"
}
Response
200
application/json
The workflow has been successfully initiated.
Available options:
completed
, running
, failed
, queued
, cancelled