Skip to main content
POST
/
api
/
v1
/
dev
/
bulk-render
/
file
Create bulk render job from file
curl --request POST \
  --url https://api.autype.com/api/v1/dev/bulk-render/file \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form documentId=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'webhookUrl=<string>'
{
  "bulkJobId": "<string>",
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "webhookUrl": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.autype.com/llms.txt

Use this file to discover all available pages before exploring further.

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