Skip to main content
POST
/
api
/
v1
/
dev
/
bulk-render
Create bulk render job from JSON
curl --request POST \
  --url https://api.autype.com/api/v1/dev/bulk-render \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "documentId": "<string>",
  "format": "PDF",
  "items": [
    {
      "companyName": "Acme Inc",
      "date": "2024-01-01"
    },
    {
      "companyName": "Beta Corp",
      "date": "2024-01-02"
    }
  ],
  "webhook": {
    "webhookUrl": "https://example.com/webhook",
    "webhookAuth": {
      "headerName": "X-API-Key",
      "headerValue": "my-secret-key",
      "basicAuthUsername": "user",
      "basicAuthPassword": "pass"
    }
  }
}
'
{
  "bulkJobId": "<string>",
  "status": "PENDING",
  "format": "PDF",
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "webhookUrl": "<string>"
}

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:
[
{
"companyName": "Acme Inc",
"date": "2024-01-01"
},
{
"companyName": "Beta Corp",
"date": "2024-01-02"
}
]
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