Skip to main content
POST
Queue a file conversion
This call returns an admission receipt. Poll the get endpoint until work stops, then download the artifacts. See job lifecycle.

TypeScript

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required
Required string length: 1 - 200

Body

application/json
input
object
required
output
object
required
limits
object

The base fee is graduated per API account each UTC calendar month: requests 1-1000 $0.05, 1001-5000 $0.035, 5001-10000 $0.02, then $0.01. Each newly accepted request counts once across all keys, including later failures/cancellations. Retries with the same idempotency key do not count again. The rate is pinned on admission; CPU and inference rates do not change with volume.

Example:
inference
object
metadata
object
Example:
output_encryption
object

Encrypt exported artifact bytes using compact JWE, RSA-OAEP-256 and A256GCM. Only encrypted files are downloadable. Disables prompt continuation and artifact reuse; cannot be combined with previous_prompt_id or artifact_id input. Prompts require editing or export_document=true.

retention
object

Response

Queued 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
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