Workflows v2 (Plays) / CLI
Run workflow
Execute an explicitly identified saved workflow against a batch of input records. Never use this for a generic content request. Graphs containing hosted AI require allowHostedAi=true from a hosted-enabled client; external-only clients are rejected before a run is created. Deterministic graphs need no hosted-AI consent. Each record is one row processed by the DAG end-to-end. Execution is fire-and-forget - the route returns 202 with an execution_id immediately; poll list-workflow-runs or get-workflow-run for status.
pipeline run-workflowDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
workflowIdRequired · string- Workflow UUID to execute.
allowHostedAiOptional · boolean- Explicit consent for hosted AI nodes. Requires a hosted-enabled client.
recordsRequired · array- Array of input records, one per row to process. Shape matches the workflow's expected input schema.
pipeline run-workflow \
--workflow-id "00000000-0000-4000-8000-000000000000" \
--records-json '[{}]'Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"workflowId": {
"type": "string",
"description": "Workflow UUID to execute."
},
"allowHostedAi": {
"type": "boolean",
"description": "Explicit consent for hosted AI nodes. Requires a hosted-enabled client."
},
"records": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Array of input records, one per row to process. Shape matches the workflow's expected input schema."
}
},
"required": [
"workflowId",
"records"
]
}