Resources
Get a batch
Read a batch's totals, credits, and progress.
GET /api/batches/{batchId}Requires batches:read.
| Name | Type | Required | Description |
|---|---|---|---|
workspace | string | Yes | Workspace slug or id. |
curl "https://app.kalpana.one/api/batches/bat_123?workspace=acme" \
--header "x-api-key: $KALPANA_API_KEY"The response has the same fields as an item in List batches, minus templateName and missingFonts. A batch that is not in the workspace returns 404.
Reading progress
status | Meaning |
|---|---|
pending | No jobs, or jobs are still waiting to be dispatched. |
processing | At least one job is rendering. |
completed | Every job rendered. |
partial | Some jobs rendered and the rest failed or were cancelled. |
failed | No job rendered and at least one failed. |
cancelled | No job rendered, none failed, and some were cancelled. |
partial means some jobs have files and others do not. Compare jobs.failed and jobs.cancelled with jobs.total, and inspect the jobs with List a batch's jobs.
Poll with a delay of a few seconds.
Was this page helpful?
Updated 9 Nov 2026