Kalpana Docs
Resources

List a batch's jobs

Page through the jobs of a batch with their status, values and files.

A batch makes one job per row and page. This lists them, in the same job shape every other jobs call uses.

GET /api/batches/{batchId}/jobs

Requires batches:read.

NameTypeRequiredDescription
workspacestringYesWorkspace slug or id.
pagenumberNoPage number, from 1. Defaults to 1.
limitnumberNoJobs per page. Defaults to 50, maximum 100.
curl "https://app.kalpana.one/api/batches/9a2e6f31-5c7d-4b08-8e1a-d4f2c6b0a937/jobs?workspace=acme&page=1&limit=50" \
  --header "x-api-key: $KALPANA_API_KEY"

Response

{
  "jobs": [
    {
      "id": "7b0c2d1e-4f5a-4c8b-9e3d-2a6f1b8c0d11",
      "status": "success",
      "template": { "id": "t4hz8c1n", "name": "Weekend sale" },
      "page": { "id": "k7fq2m8a", "name": "Feed" },
      "flow": null,
      "batch": "9a2e6f31-5c7d-4b08-8e1a-d4f2c6b0a937",
      "modifications": { "Headline": "Weekend offer", "Photo": { "asset": "0b0f5a3e-5b1c-4d65-9a5e-3f7d2f2f6c11", "name": "shoe.png" } },
      "output": { "format": "png", "kind": "image" },
      "creditCost": 1,
      "error": null,
      "file": {
        "creativeId": "5d3a9c70-1e2b-4f86-a7c4-90b1d2e3f4a5",
        "url": "https://cdn.kalpana.one/...",
        "fileName": "weekend-offer Feed.png",
        "contentType": "image/png",
        "sizeBytes": 284113,
        "width": 1080,
        "height": 1080
      },
      "createdAt": "2026-11-09T10:00:00.000Z",
      "updatedAt": "2026-11-09T10:00:04.000Z"
    }
  ],
  "total": 4,
  "page": 1,
  "limit": 50
}

The fields of a job are described in The job object.

statusMeaning
pendingCreated or edited; not yet dispatched.
processingDispatched and rendering.
successA file exists; file holds a link.
failedRendering failed; error says why. Run it again with Run a job, or change it first with Update a batch.
cancelledStopped by a cancel before it rendered. Final, and not charged.

Jobs are ordered by creation, row by row with each row's pages in order, so a page boundary stays stable while the batch renders. total counts every job of the batch. A batch that is not in the workspace returns 404.

Errors

StatusCause
400page or limit is not a whole number in range.
403Your role or key lacks batches:read.
404The batch is not in this workspace.
Was this page helpful?

Updated 9 Nov 2026

On this page