Skip to main content
POST
Create bulk render job from file

Authorizations

X-API-Key
string
header
required

API Key (starts with ak_...)

Body

multipart/form-data
file
file
required

CSV, Excel (.xlsx), or JSON file

documentId
string<uuid>
required

Document ID to render

format
enum<string>
required

Output format

Available options:
PDF,
DOCX,
ODT
webhookUrl
string

Webhook URL for completion notification

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