Resources
List batches
List batches in a workspace with row counts, credits, and derived status.
GET /api/batchesRequires batches:read.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace | string | Yes | Workspace slug or id. |
templateId | string | No | Only batches with at least one job from this template. |
status | string | No | Filter by draft, published, or archived. |
page | number | No | Page number. Defaults to 1. |
limit | number | No | Items per page. Defaults to 20, maximum 100. |
curl "https://app.kalpana.one/api/batches?workspace=acme&status=published" \
--header "x-api-key: $KALPANA_API_KEY"Response
The response contains the page of batches and a total, the number of matching batches. It also carries totalProcessedFiles, totalProcessedImages and totalProcessedVideos, counts of every file rendered in the workspace. Batches are newest first. Each batch has:
| Field | Description |
|---|---|
id, workspaceId, name, description, meta | Batch identity and notes. |
batchStatus | The stored lifecycle state: draft, published, or archived. |
status | The derived progress: pending, processing, completed, partial, failed, or cancelled. |
templateId, templateName | A template used by the batch. null for a batch with no rows. |
jobs | Job counts: total, succeeded (jobs with a file), failed, processing, cancelled and pending. A batch has one job per row and page, so 10 rows on 3 pages is 30 jobs. |
pendingImageJobs, pendingVideoJobs | Jobs not yet dispatched, by kind. |
imageCredits, videoCredits | Credits still required for pending jobs. |
missingFonts | Fonts the template needs that the workspace lacks, each with family, style, weight and italic. |
createdBy, createdAt, updatedAt | Audit fields. |
Was this page helpful?
Updated 9 Nov 2026