Skip to navigation
API referenceJobs

Cancel a Job

No body and no Idempotency-Key: the operation is naturally idempotent. A queued job is cancelled now and answers 200 with status: "cancelled"; it is never billed, its credit hold is released and its daily quota unit refunded. A job already picked up for processing answers 202 with its current state (queued or running) and a Retry-After: cancellation is requested and honoured at the next stage boundary before processing starts. Once processing has started the job runs to completion and is billed, so a polled 202 job may end succeeded (or failed) rather than cancelled. A job that already finished answers 409 JOB_NOT_CANCELLABLE; one already cancelled answers 200 with that job. The body is the Job a GET answers next, with the same ETag. Requires the scope of the job’s operation.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

job_idstringRequired

Response headers

Cache-ControlstringOptional
API responses are private to the caller and not cacheable
ETagstringOptional
Opaque version of the current job representation
Retry-AfterstringOptional

Delay before retrying, expressed as delta-seconds

X-Request-IdstringOptional
Request correlation identifier

Response

The job is cancelled (now, or by an earlier request)

completed_atdatetime or null
created_atdatetime
errorobject or null
expires_atdatetime or null
idstring
inputslist of objects
operationenum

What a job does: the operation’s authorization scope.

An operation is not its output’s type: OPERATION_OUTPUT_TYPE is the one place the two meet.

Allowed values:
outputobject or null
statusenum
Allowed values:
updated_atdatetime
livemodebooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error