Skip to main content
POST
/
api
/
v1
/
dev
/
render
/
document
/
{documentId}
Render a persistent document
curl --request POST \
  --url https://api.autype.com/api/v1/dev/render/document/{documentId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "variables": {
    "name": "Acme Inc",
    "date": "2024-01-01"
  },
  "format": "pdf",
  "webhook": {
    "webhookUrl": "https://example.com/webhook",
    "webhookAuth": {
      "headerName": "X-API-Key",
      "headerValue": "my-secret-key",
      "basicAuthUsername": "user",
      "basicAuthPassword": "pass"
    }
  }
}
'
{
  "jobId": "<string>",
  "status": "PENDING",
  "format": "PDF",
  "creditCost": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "filename": "<string>",
  "error": "<string>",
  "completedAt": "2023-11-07T05:31:56Z"
}

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:
{ "name": "Acme Inc", "date": "2024-01-01" }
​
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>