API ReferenceDesign jobs
Cancel a design job
Stops the run at its next checkpoint. Unused reserved credits are given back; anything already made is kept. A finished job is returned unchanged.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
curl -X POST "https://example.com/v1/design-jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{ "id": "6a1f8c0e-2d3b-4c5a-8e9f-0a1b2c3d4e5f", "kind": "generate", "status": "running", "progress": 40, "stage": "Designing Instagram post (4:5)", "creditsReserved": 290, "creditsCharged": 140, "estimatedSeconds": 90, "designs": [ { "id": "0d9c3a52-7b1e-4f7a-9d55-3f4b2a1c9e10", "name": "Summer sale", "width": 1080, "height": 1350, "pageCount": 1, "sizePreset": "ig-post-45", "editUrl": "https://app.nimply.io/workspace/8b2e5821-…/studio/design/0d9c3a52-…", "previewUrls": [ "string" ], "thumbnailUrl": "string", "createdAt": "2026-10-21T09:00:00.000Z", "brandMatch": 82, "styleVersion": 3 } ], "error": { "code": "GENERATION_FAILED", "message": "The design could not be made." }, "createdAt": "2026-10-21T09:00:00.000Z", "finishedAt": "string"}Empty
Empty