Check batch progress
get_batchRead-onlyIdempotent
Returns one batch's overall status with its total, completed, failed, and processing job counts. Rendering after run_batch happens in the background, so repeated calls track it until processing reaches 0. list_batches gives the same counts for many batches at once; per-job values and render errors are in get_batch_jobs, and download URLs in get_batch_outputs. Needs batches:read.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batchId | Yes | Batch ID returned by create_batch or list_batches |
Output Schema
TableJSON 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 |