cancel_deck

Type: Write · Required scope: decks:write · Cost: Free (credits from the canceled job are refunded)

Parameters

string

required

The job ID to cancel.

Returns the updated job object with status: "canceled". All reserved credits are returned to your balance immediately.

Show Example response

{
  "id": "job_abc123",
  "status": "canceled",
  "credits_reserved": 100,
  "credits_charged": 0,
  "finished_at": "2026-06-23T10:03:12Z"
}

You can cancel jobs in queued or running state. Jobs that are succeeded, failed, or already canceled cannot be canceled again.

Useful when you’ve started too many jobs or want to free up your active job slots (there’s a small concurrent-job limit per account).

Error	Cause
`Job is already 'succeeded' and can no longer be canceled`	Job finished before the cancel arrived
`Deck job 'X' not found`	Invalid job ID