Skip to main content
POST
Create bulk render job from JSON

Authorizations

X-API-Key
string
header
required

API Key (starts with ak_...)

Body

application/json
documentId
string
required

Document ID to render

format
enum<string>
required
Available options:
PDF,
DOCX,
ODT
Example:

"PDF"

items
object[]
required

Array of variable sets. Each object represents one document to generate.

Example:
webhook
object

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

Response

Bulk render job created

bulkJobId
string
required

Bulk job ID for status polling

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

Total number of items to render

completedItems
number
required

Number of completed items

failedItems
number
required

Number of failed items

createdAt
string<date-time>
required
webhookUrl
string

Webhook URL if configured