Skip to main content
POST
Render a persistent document

Authorizations

X-API-Key
string
header
required

API Key (starts with ak_...)

Path Parameters

documentId
string
required

ID of the persistent document to render

Body

application/json
variables
object

Variable overrides (merged with variables defined in the document)

Example:
format
enum<string>

Override the output format. If omitted, uses the format from the document JSON (document.type field).

Available options:
pdf,
docx,
odt
webhook
object

Optional webhook configuration. Receives a POST when the job completes or fails.

Response

Render job created

jobId
string
required

Render job ID for status polling

status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
format
enum<string>
required
Available options:
PDF,
DOCX,
ODT
creditCost
number
required

Credit cost for this render job

createdAt
string<date-time>
required
downloadUrl
string

Autype API download URL with signed token (only when completed). Supports direct browser download.

filename
string

Filename for download

error
string

Error message if failed

completedAt
string<date-time>