Revise API menu

Cancel a conversion

POSThttps://revise.io/api/v1/convert/{id}/cancel

Send no body. Queued work stops immediately; running work may still be stopping when the response returns. Poll until terminal. Completed jobs remain completed. Cancellation can incur charges for work already performed.

See conversion formats and limits for integration guidance.

TypeScript#

TypeScript
import { ReviseClient } from "@reviseio/api";

const revise = new ReviseClient({ apiKey: process.env.REVISE_API_KEY! });
const result = await revise.conversions.cancel("conversion_id");

Authorization#

Authorizationstringrequired

Bearer <key>, with an API key from the console.

Path parameters#

idstringrequired

Responses#

202ConversionCancellation requested
idstringrequired
objectstringrequired

always "conversion"

statusstringrequired

one of "queued", "running", "succeeded", "failed", "cancelled"

modestringrequired

Empty after request content has been deleted.

one of "deterministic", "vision", ""

inputobjectrequired
Properties
file_idstringrequired
formatstringrequired

Empty after request content has been deleted.

one of "pdf", "docx", "md", "html", "txt", "rtf", "odt", "image", ""

filenamestringrequired
bytesintegerrequired
sha256stringrequired
outputobjectrequired
Properties
formatstringrequired

Empty after request content has been deleted.

one of "docx", "pdf", "md", "html", "txt", ""

artifactArtifact | nullrequired
output_encryptedbooleanrequired
metadataMetadatarequired

Up to 16 string values for application attribution. Keys are 1–64 UTF-8 bytes; values at most 512 UTF-8 bytes. Metadata is deleted with request content; persist your own job mapping for long-term attribution.

example {"customer":"acme","environment":"production"}

usageUsage | nullrequired
created_atstring<date-time>required
completed_atstring | nullrequired
content_expires_atstring | nullrequired
content_deleted_atstring | nullrequired
errorobject | nullrequired
retentionRetentionOptions
Properties
delete_after_webhook_idstringrequired

Account-owned endpoint subscribed to prompt.completed or conversion.completed, matching the request kind. Its successful acknowledgement deletes request content and ephemeral source. Download everything before returning 2xx.

defaultErrorError
errorobjectrequired
Properties
codestringrequired
messagestringrequired
detailsobject