Cancel a queued job

POST

/v1/jobs/{id}/cancel

Cancels a job that no worker has picked up yet. Running jobs cannot be stopped (409).

Authorizations

apiKey

An API key from the console (API keys). Only its SHA-256 is stored; it is shown once.

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Example"job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3"

Responses

Cancelled.

Content-Type

application/json

{

  

"id": "job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3",

  

"object": "job",

  

"utility": "html-pdf",

  

"mode": "async",

  

"status": "cancelled",

  

"createdAt": "2026-09-10T17:30:08.412Z",

  

"startedAt": null,

  

"finishedAt": "2026-09-10T17:30:10.771Z",

  

"timings": {

  

  

"queueMs": 0,

  

  

"upstreamMs": 2140,

  

  

"storageMs": 196,

  

  

"totalMs": 2359

  

},

  

"metadata": {

  

  

"orderId": "ORD-1042"

  

},

  

"result": null,

  

"error": null,

  

"callback": null,

  

"links": {

  

  

"self": "/v1/jobs/job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3"

  

}

}

POST

/v1/jobs/{id}/cancel

Playground

Authorization

apiKey

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI