Cancel a queued job
Needs the scope jobs:write
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.
jobId*stringThe job id.
Format
uuidIdempotency-Key?stringA unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.
Length
length <= 128OK
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 -X POST https://platform.charpstar.co/api/v1/jobs/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/cancel \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"Example Response
{ "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045", "type": "packshot", "articleId": "CH-1001", "variant": null, "status": "cancelled", "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": null, "finishedAt": "2026-11-02T08:00:20.000Z", "outputs": [], "error": null}