Conversions

Cancel a conversion

Stop a job that hasn't finished. Safe to repeat.

POST/v1/conversions/{id}/cancel

Pages not converted before the cancel aren't charged.

Authentication

An API key with the conversions:write scope, or the signed-in website.

Path parameters

idstringrequired

The job ID.

Response

202 Accepted

idstring

The job ID.

statestring

queued, processing, succeeded, failed or cancelled. See all states.

channelstring

Where it came from: api, web or desktop.

input_filenamestring

The uploaded file name.

input_bytesinteger

The size of the upload.

optionsobject

The options in use, with defaults filled in.

page_countinteger or null

Pages in the PDF, once it has been opened.

pages_selectedinteger or null

Pages this job converts.

pages_succeededinteger

Pages converted so far.

pages_failedinteger

Pages that failed.

credits_reservedinteger

Credits held while the job runs.

credits_consumedinteger

Credits charged. Only converted pages are charged.

errorobject or null

What went wrong. See job errors.

cancel_requestedboolean

Whether a cancel was requested.

results_expire_atstring or null

When the images will be deleted.

created_atstring

When the job was created.

started_atstring or null

When a worker started it.

finished_atstring or null

When it ended.

Errors

Status	Code	What to do
401	`unauthenticated`	The API key is missing, invalid, expired or revoked.
403	`insufficient_scope`	Use a key with the scope shown above.
404	`not_found`	Check the ID. It may belong to another workspace.

Request

PHPPythonNode.jscURL

<?php
$api = getenv('RASTERNIVO_API_URL') ?: 'https://rasternivo-api.swiftinfocorp.com/v1';
$id = getenv('RASTERNIVO_JOB_ID');

$ch = curl_init("$api/conversions/$id/cancel");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('RASTERNIVO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

echo $data['state'], "\n";

import os
import requests

API = os.environ.get("RASTERNIVO_API_URL", "https://rasternivo-api.swiftinfocorp.com/v1")

data = requests.post(
    f'{API}/conversions/{os.environ["RASTERNIVO_JOB_ID"]}/cancel',
    headers={"Authorization": "Bearer " + os.environ["RASTERNIVO_API_KEY"]},
).json()

print(data["state"])

const API = process.env.RASTERNIVO_API_URL ?? "https://rasternivo-api.swiftinfocorp.com/v1";

const res = await fetch(`${API}/conversions/${process.env.RASTERNIVO_JOB_ID}/cancel`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.RASTERNIVO_API_KEY}` },
});
const data = await res.json();

console.log(data.state);

curl -X POST "https://rasternivo-api.swiftinfocorp.com/v1/conversions/$RASTERNIVO_JOB_ID/cancel" \
  -H "Authorization: Bearer $RASTERNIVO_API_KEY"

Response 202

{
  "id": "01a19b62-dd01-7c80-811b-74793f0a32b6",
  "state": "cancelled",
  "channel": "api",
  "created_at": "2026-11-02T08:31:50Z",
  "started_at": "2026-11-02T08:31:50Z",
  "finished_at": "2026-11-02T08:31:51Z",
  "input_filename": "report.pdf",
  "input_bytes": 3585,
  "options": {
    "pages": "1-3", "dpi": 300, "quality": 90, "subsampling": "auto",
    "background": "#FFFFFF", "name_template": "{original}_page_{page_number:0001}", "zip": true
  },
  "page_count": 10,
  "pages_selected": 3,
  "pages_succeeded": 3,
  "pages_failed": 0,
  "credits_reserved": 9,
  "credits_consumed": 9,
  "error": null,
  "cancel_requested": true,
  "results_expire_at": "2026-11-02T09:31:51Z"
}