Cancel a conversion
https://revise.io/api/v1/convert/{id}/cancelSend 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#
import { ReviseClient } from "@reviseio/api";
const revise = new ReviseClient({ apiKey: process.env.REVISE_API_KEY! });
const result = await revise.conversions.cancel("conversion_id");Authorization#
AuthorizationstringrequiredBearer <key>, with an API key from the console.
Path parameters#
idstringrequiredResponses#
202ConversionCancellation requested
idstringrequiredobjectstringrequiredalways "conversion"
statusstringrequiredone of "queued", "running", "succeeded", "failed", "cancelled"
modestringrequiredEmpty after request content has been deleted.
one of "deterministic", "vision", ""
inputobjectrequiredProperties
file_idstringrequiredformatstringrequiredEmpty after request content has been deleted.
one of "pdf", "docx", "md", "html", "txt", "rtf", "odt", "image", ""
filenamestringrequiredbytesintegerrequiredsha256stringrequiredoutputobjectrequiredProperties
formatstringrequiredEmpty after request content has been deleted.
one of "docx", "pdf", "md", "html", "txt", ""
artifactArtifact | nullrequiredoutput_encryptedbooleanrequiredmetadataMetadatarequiredUp 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 | nullrequiredcreated_atstring<date-time>requiredcompleted_atstring | nullrequiredcontent_expires_atstring | nullrequiredcontent_deleted_atstring | nullrequirederrorobject | nullrequiredretentionRetentionOptionsProperties
delete_after_webhook_idstringrequiredAccount-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
errorobjectrequiredProperties
codestringrequiredmessagestringrequireddetailsobject