Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

BatchRunResponse

Result of a WorkPlan batch fan-out (cycles execute asynchronously).

FieldTypeDescription
workstream_idrequiredstring (uuid)—
job_definition_idrequiredstring (uuid)—
job_permakeystring | nullJob permakey for the post-create batch deep-link URL /workstreams/cycles/{permakey} (#173); null on legacy rows.
requestedrequiredinteger—
startedrequiredinteger—
failedrequiredinteger—
cyclesobject[]Per-cycle outcomes: [{cycle_id, client_id, workflow_id, status, error?}]
item shape
Empty object.