Workflows API
The Workflows API lets you create, manage, and run workflows programmatically.
Endpoints
List Workflows
GET /api/v1/workflows
Returns all workflows owned by the authenticated user.
Get Workflow
GET /api/v1/workflows/:id
Returns a single workflow with its steps and configuration.
Run a Workflow
POST /api/v1/workflows/:id/run
Starts a new run of the specified workflow. Returns a run ID that you can use to poll for status.
Get Run Status
GET /api/v1/workflows/runs/:runId/status
Returns the current status and outputs of a workflow run. Use this endpoint to poll for completion.
Response Format
All responses follow a standard envelope format with data and error fields. Successful responses include the resource in the data field. Error responses include a human-readable message in the error field.