Read one job
Needs the scope jobs:read
One job: its status, options as applied, outputs once it succeeded, and the error when it failed.
jobId*stringThe job id.
Format
uuidOK
application/json- response
id*stringFormat
uuidtype*stringValue in
"packshot""scene""edit""video""export"articleId*stringvariant*string|nullstatus*stringValue in
"queued""running""succeeded""failed""cancelled"options*The options as applied, defaults filled in.
naming*|nullmetadata*createdAt*stringFormat
date-timestartedAt*|nullfinishedAt*|nulloutputs*array<>The files made, in the order asked for. Empty until the job finishes; a failed job lists the files it did make.
error*|Why the job failed, when it did.
curl -sS https://platform.charpstar.co/api/v1/jobs/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045 \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"Example Response
{ "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045", "type": "packshot", "articleId": "CH-1001", "variant": null, "status": "succeeded", "options": { "views": [ "front", "left", "back" ], "background": "transparent", "size": 4096, "aspectRatio": "1:1", "format": "png", "shadows": true, "lighting": "studio", "preset": "Marketplace (GS1)" }, "naming": { "preset": "gs1" }, "metadata": { "purchaseOrder": "PO-88213" }, "createdAt": "2026-11-02T08:00:00.000Z", "startedAt": "2026-11-02T08:01:10.000Z", "finishedAt": "2026-11-02T08:09:52.000Z", "outputs": [ { "id": "c41f9a07-2b3c-4d5e-8f6a-7b8c9d0e1f2a", "type": "packshot", "view": "front", "format": "png", "fileName": "09521234567806_C1C0.png", "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C1C0.png", "width": 4096, "height": 4096, "bytes": 3210442 }, { "id": "5e83d1b2-3c4d-4e5f-9a6b-8c9d0e1f2a3b", "type": "packshot", "view": "left", "format": "png", "fileName": "09521234567806_C2C0.png", "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C2C0.png", "width": 4096, "height": 4096, "bytes": 3210442 }, { "id": "f0a7c6e9-4d5e-4f6a-8b7c-9d0e1f2a3b4c", "type": "packshot", "view": "back", "format": "png", "fileName": "09521234567806_C7C0.png", "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C7C0.png", "width": 4096, "height": 4096, "bytes": 3210442 } ], "error": null}List jobs GET
Your jobs, newest first, with their status and outputs. Filter by article, type, status, or changes since a time.
Cancel a queued job POST
Cancel a job while it is queued. A job that has started answers 409 not_cancellable. job.cancelled is sent. Cancelling a cancelled job answers it again.