Resources
Get a job
Read one job with its status, the values it was made from, its error and its file.
GET /api/jobs/{jobId}Requires batches:read.
| Name | Type | Required | Description |
|---|---|---|---|
workspace | string | Yes | Workspace slug or id. |
curl "https://app.kalpana.one/api/jobs/7b0c2d1e-4f5a-4c8b-9e3d-2a6f1b8c0d11?workspace=acme" \
--header "x-api-key: $KALPANA_API_KEY"Response
The job alone, not wrapped in a list:
{
"id": "7b0c2d1e-4f5a-4c8b-9e3d-2a6f1b8c0d11",
"status": "failed",
"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": "The render failed.",
"file": null,
"createdAt": "2026-11-09T09:41:07.512Z",
"updatedAt": "2026-11-09T09:41:10.640Z"
}The fields are described in The job object. modifications is null for a job made in the Kalpana app. success, failed and cancelled are final; pending and processing are not. A job that does not exist in the workspace returns 404.
To read several jobs in one call, use Get jobs.
Was this page helpful?
Updated 9 Nov 2026