Skip to main content
POST
Upload a file
See files and retention for integration guidance.

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 nonempty file, at most 18 MiB. Accounts may retain up to 100 undeleted uploads totaling 256 MiB. Filename: at most 255 bytes, with no path separators or control characters. DOCX/ODT expanded archives are limited to 128 MiB; DOCX archives may contain at most 10,000 entries.

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
required
lifetime
enum<string>
required
Available options:
ephemeral,
persistent