Skip to main content
POST
/
workflows
/
{workflow_id}
/
start
Start Workflow Run
curl --request POST \
  --url https://api.curalabs.io/v1/workflows/{workflow_id}/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "developer_user_id": "user-unique-id-in-your-system"
}
'
{
  "run_id": "wfr_ghi789jkl012",
  "status": "queued"
}
Initiate an execution run of a defined workflow. See the API Reference for details on operationId: startWorkflowRun.

Authorizations

​
X-API-Key
string
header
required

API Key provided by the platform. Note- X-Timestamp and X-Signature headers are also required for authentication, but not defined as separate schemes here due to OpenAPI limitations on complex signature schemes.

Path Parameters

​
workflow_id
string
required

The ID of the workflow definition to run.

Example:

"wf_abc123def456"

Body

application/json
​
developer_user_id
string
required

Unique identifier for the end-user in your system whose extension should execute the workflow.

Example:

"user-unique-id-in-your-system"

Response

Accepted. The workflow run has been successfully queued.

​
run_id
string

Unique identifier for this specific workflow execution run.

Example:

"wfr_ghi789jkl012"

​
status
enum<string>

Initial status of the workflow run.

Available options:
queued,
processing,
completed,
failed
Example:

"queued"