Cancel a job

Cancels a job that has not finished and releases its 1-cent reservation. Cancelling a finished job changes nothing and returns it as it is, so check status in the response: succeeded means the job finished first and was billed.

The uploaded file still counts toward your storage limit until the job expires 24 hours after creation.

POST/v1/jobs/{id}/cancel

Authorization

AuthorizationBearer token · headerrequired

A cvt_live_ API key from the dashboard, sent as Authorization: Bearer cvt_live_…. Keep it on your server.

Path parameters

idstringrequired

The job id returned when you created the job, such as job_01k6z7v4q8m3x2a9b5c0d1e2f3.

Responses

200

The job after cancellation.

idstringrequired

Job id, prefixed job_.

statusstringrequired

created → queued → running → succeeded or failed. cancelled can happen at any point before the job finishes. uploaded is reserved and not used yet.

Allowed:createduploadedqueuedrunningsucceededfailedcancelled

input_formatstring

target_formatstring

input_bytesinteger | null

Size you reserved

attemptinteger

How many times a worker has picked up the job. Starts at 0.

error_codestring | null

Why a failed job failed (conversion_failed, expired_or_exhausted or worker_shutdown), otherwise null.

expires_atstring<date-time>required

When the job and its files are deleted

400

Request refused

errorobject

Show properties

codestring

messagestring

401

unauthorized: no Authorization: Bearer header.

errorobject

Show properties

codestring

messagestring

403

unauthorized (key invalid or revoked) or a billing limit.

errorobject

Show properties

codestring

messagestring

404

not_found: the job does not exist, belongs to another account, or has expired.

errorobject

Show properties

codestring

messagestring

429

rate_limited: more than 120 requests in a minute for this key.

errorobject

Show properties

codestring

messagestring

502

storage_unavailable: object storage did not answer. Retry with backoff.

errorobject

Show properties

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*The job id returned when you created the job, such as `job_01k6z7v4q8m3x2a9b5c0d1e2f3`.

Request

curl -X POST 'https://convt-api-production.up.railway.app/v1/jobs/job_01k6z7v4q8m3x2a9b5c0d1e2f3/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

import axios from "axios";

const response = await axios.request({
  method: "POST",
  url: "https://convt-api-production.up.railway.app/v1/jobs/job_01k6z7v4q8m3x2a9b5c0d1e2f3/cancel",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

const response = await fetch("https://convt-api-production.up.railway.app/v1/jobs/job_01k6z7v4q8m3x2a9b5c0d1e2f3/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.post(
    "https://convt-api-production.up.railway.app/v1/jobs/job_01k6z7v4q8m3x2a9b5c0d1e2f3/cancel",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "status": "created",
  "input_format": "string",
  "target_format": "string",
  "input_bytes": 0,
  "attempt": 0,
  "error_code": "string",
  "expires_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}