List jobs
Needs the scope jobs:read
Your jobs, newest first, with their status and outputs. Filter by article, type, status, or changes since a time.
articles?stringOnly jobs for these article numbers, comma separated.
type?stringOnly this job type.
"packshot""scene""edit""video""export"status?stringOnly this status.
"queued""running""succeeded""failed""cancelled"since?stringOnly jobs changed after this time.
date-timelimit?integerItems per page, 1 to 100. Default 100.
1 <= value <= 100cursor?stringThe nextCursor of the previous page.
OK
application/json- response
jobs*array<>nextCursor*|Pass it as cursor for the next page. null when there is no more.
curl -sS "https://platform.charpstar.co/api/v1/jobs?status=succeeded&since=2026-11-01T00:00:00Z" \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"{ "jobs": [ { "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 } ], "nextCursor": null}Start one job or a batch POST
Start one job, or up to 50 as { jobs: [...] }. Jobs run our production services on a delivered product: packshot renders, AI scenes, image edits, videos and 3D exports. Every job type runs. - Jobs queue, and the results are added to the product: new images appear in images[] with the job's id, asset.images.updated is sent, and job.succeeded carries the job with its outputs. - Pictures are made in the order asked, and each is saved under its fileName from the start. - A batch answers a results array like POST /api/v1/products. - A product without a delivered model answers 409 not_ready (edit jobs work on an image and need no model). - AI jobs (scenes, edits, scene videos) run for an account with an allowance of their kind; without one they answer 403 forbidden. - An export to a format not switched on for your account answers 403 forbidden.
Read one job GET
One job: its status, options as applied, outputs once it succeeded, and the error when it failed.