Check batch progress
get_batchRead-onlyIdempotent
Returns one batch's status with its total, completed, failed and processing job counts. Rendering after run_batch happens in the background, so call it again until processing reaches 0. An unknown batchId, or one from another workspace, returns Batch not found. For many batches at once use list_batches; for per-job values and render errors get_batch_jobs; for download URLs get_batch_outputs. Needs batches:read.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"batchId": "<batchId>"
},
"name": "get_batch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batchId | Yes | Batch ID returned by create_batch or list_batches |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| total | Yes | Jobs in the batch | |
| failed | Yes | Jobs that failed | |
| status | Yes | processing while any job renders; pending while jobs wait for run_batch; once every job has finished: completed when all rendered, partial when some rendered and others failed or were cancelled, failed when none rendered and at least one failed, cancelled when none rendered, none failed and at least one was cancelled. The counts carry the detail | |
| cancelled | No | Jobs cancelled | |
| completed | Yes | Jobs rendered | |
| createdAt | Yes | Creation time, ISO 8601 | |
| processing | Yes | Jobs rendering now | |
| workspaceId | Yes |