Skip to main content
GET
Read conversion status, receipt, and output artifact
See conversion formats and limits for integration guidance.

TypeScript

Authorizations

Authorization
string
header
required

Revise API key from https://revise.io/console/api-keys. Send Authorization: Bearer .

Path Parameters

id
string
required

Response

Conversion

id
string
required
object
any
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
mode
enum<string>
required

Empty after request content has been deleted.

Available options:
deterministic,
vision,
input
object
required
output
object
required
output_encrypted
boolean
required
metadata
object
required

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:
usage
object | null
required

Customer-facing settled charges and usage. Supplier costs, margins and internal reconciliation diagnostics are not exposed. Historical charges are never recalculated using current prices.

Example:
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
content_expires_at
string<date-time> | null
required
content_deleted_at
string<date-time> | null
required
error
object | null
required
retention
object