Skip to main content
DELETE
Cancel Job

Overview

Cancel a job that is still waiting in the queue or already being processed.
  • Queued — the job is dropped immediately and will never run.
  • In flight — the worker stops at its next checkpoint: within a few seconds during the download, right after the download, right after the mux, and at any point during the upload. Nothing is delivered and nothing is billed.
  • Already delivered — a file that has already reached your storage is not recalled. If the cancellation lands in the last moments before the job is finalized, the job completes normally and is billed. While the worker is aborting, a poll may briefly show Cancelled; the final status is what counts.
Jobs that already have a final status (Completed, Failed, Warning, Skipped, Cancelled, CancelledByAdmin) cannot be cancelled. This endpoint cancels work; it does not delete the job record or its stored file. A job in Warning has already stopped, so cancelling it returns 400. Use Delete Job File to remove a delivered file.

Header Parameters

string
required
Your API key for authentication

Path Parameters

uuid
required
The job UUID to cancel

Response

string
Human-readable outcome
string
The job ID
string
cancelled — the job was still queued and is gone. cancelling — the job was in flight; the worker aborts at its next checkpoint (poll the job to see the final status).

Examples

Success Response

Error Responses

Notes

  • Cancelled jobs end with status Cancelled and the error message “Job cancelled by user”; they are never billed.
  • Cancellation can interrupt an in-flight pipeline. If completion won the race, the job is already terminal. An interrupted multipart upload may leave incomplete parts; cleanup depends on the storage provider and lifecycle configuration.
  • A job whose file was already delivered when the cancellation arrived completes and is billed — check the final status with GET /jobs/{id}.
  • Cancellation is atomic on our side: a job reported as cancelled will not be picked up by a worker.