Skip to main content
GET
/
api
/
v1
/
dev
/
bulk-render
/
{bulkJobId}
Get bulk render job status
curl --request GET \
  --url https://api.autype.com/api/v1/dev/bulk-render/{bulkJobId} \
  --header 'X-API-Key: <api-key>'
{
  "bulkJobId": "<string>",
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "error": "<string>",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API Key (starts with ak_...)

Path Parameters

​
bulkJobId
string
required

Response

Bulk render job status

​
bulkJobId
string
required

Bulk job ID

​
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

​
completedItems
number
required

Number of completed items

​
failedItems
number
required

Number of failed items

​
createdAt
string<date-time>
required
​
downloadUrl
string

Autype API download URL with signed token for ZIP (only when completed). Alternatively use GET /bulk-render/{bulkJobId}/download with API key.

​
error
string

Error message if failed

​
completedAt
string<date-time>