Skip to main content
POST
Upload one immutable source (PDF, DOCX, MD, HTML, TXT, RTF, ODT, PNG, JPEG, WebP or GIF)

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

multipart/form-data
file
file
required

One file with a supported filename. Maximum 18 MiB; 100 files/256 MiB per local account.

lifetime
enum<string>
default:ephemeral

Ephemeral files can be claimed by one request and are deleted immediately on success. Failed or cancelled requests retain their source for 24 hours; unused uploads expire 24 hours after upload. Persistent templates remain until explicit deletion.

Available options:
ephemeral,
persistent

Response

Idempotent upload replay

id
string
required
filename
string
required

Empty once expired or deleted.

bytes
integer
required
sha256
string
required
status
enum<string>
required
Available options:
uploaded,
expired,
deleted
created_at
string<date-time>
required
expires_at
string<date-time> | null
required
deleted_at
string<date-time> | null
lifetime
enum<string>
Available options:
ephemeral,
persistent