Sign in

v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Runs

Start a new agent run

Start tracking a new agent run for a customer workflow.

Returns a run ID that can be used to emit events and track execution. The run starts in PENDING status and transitions to RUNNING when the first event is emitted.

post/v1/runs

Request body

customerIdstring required

Customer ID (must exist)

workflowIdstring required

Workflow ID (must exist)

externalRunIdstring

Your system run ID (must be unique per business)

correlationIdstring

Cross-service tracing ID for linking runs across services

parentRunIdstring

Parent run ID for nested/sub-runs

metadataobject

Arbitrary metadata to attach to the run

Example request

{
  "customerId": "cus_abc123",
  "workflowId": "wf_abc123"
}

Response

Run started

idstring
customerIdstring
workflowIdstring
workflowNamestring
statusstring
correlationIdstring nullable
createdAtstring date-time