Cancel a job

DELETEupscalr.app/api/v1/jobs/{id}

Cancels a job that has not finished and returns its credits. Jobs that already reached a final state cannot be cancelled.

Request

Parameter	Type	Description
id	path, required	The job id to cancel.

curl -X DELETE https://upscalr.app/api/v1/jobs/cmrw0iqm8000bdcs3um6ii7fa \
  -H "Authorization: Bearer $UPSCALR_API_KEY"

Requires the jobs:write scope.

Response

Response · 200 OK

{
  "id": "cmrw0iqm8000bdcs3um6ii7fa",
  "object": "job",
  "status": "cancelled",
  "target": "4k",
  "credits": 3,
  "created_at": "2026-07-25T09:30:00Z",
  "finished_at": "2026-07-25T09:30:02Z"
}

Status	Meaning
200	The cancelled job.
404	No job with that id.
409	The job already finished.

A 409 conflictmeans the job finished before the cancel arrived. If it succeeded, you were charged and the result is downloadable; races between finishing and cancelling resolve in the job’s favour.

PreviousDownload the result NextWebhooks