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"
}
}
}
'import requests
url = "https://api.autype.com/api/v1/dev/bulk-render"
payload = {
"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"
}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
}
})
};
fetch('https://api.autype.com/api/v1/dev/bulk-render', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.autype.com/api/v1/dev/bulk-render",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.autype.com/api/v1/dev/bulk-render"
payload := strings.NewReader("{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.autype.com/api/v1/dev/bulk-render")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.autype.com/api/v1/dev/bulk-render")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"bulkJobId": "<string>",
"totalItems": 123,
"completedItems": 123,
"failedItems": 123,
"createdAt": "2023-11-07T05:31:56Z",
"webhookUrl": "<string>"
}Bulk Rendering
Create bulk render job from JSON
Create a bulk render job with an array of variable sets. Each item generates one document.
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"
}
}
}
'import requests
url = "https://api.autype.com/api/v1/dev/bulk-render"
payload = {
"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"
}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
}
})
};
fetch('https://api.autype.com/api/v1/dev/bulk-render', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.autype.com/api/v1/dev/bulk-render",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.autype.com/api/v1/dev/bulk-render"
payload := strings.NewReader("{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.autype.com/api/v1/dev/bulk-render")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.autype.com/api/v1/dev/bulk-render")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentId\": \"<string>\",\n \"format\": \"PDF\",\n \"items\": [\n {\n \"companyName\": \"Acme Inc\",\n \"date\": \"2024-01-01\"\n },\n {\n \"companyName\": \"Beta Corp\",\n \"date\": \"2024-01-02\"\n }\n ],\n \"webhook\": {\n \"webhookUrl\": \"https://example.com/webhook\",\n \"webhookAuth\": {\n \"headerName\": \"X-API-Key\",\n \"headerValue\": \"my-secret-key\",\n \"basicAuthUsername\": \"user\",\n \"basicAuthPassword\": \"pass\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"bulkJobId": "<string>",
"totalItems": 123,
"completedItems": 123,
"failedItems": 123,
"createdAt": "2023-11-07T05:31:56Z",
"webhookUrl": "<string>"
}Authorizations
API Key (starts with ak_...)
Body
application/json
Document ID to render
Available options:
PDF, DOCX, ODT Example:
"PDF"
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"
}
]
Optional webhook configuration. Receives a POST when the bulk job completes or fails.
Show child attributes
Show child attributes
Response
Bulk render job created
Bulk job ID for status polling
Available options:
PENDING, PROCESSING, COMPLETED, FAILED Available options:
PDF, DOCX, ODT Total number of items to render
Number of completed items
Number of failed items
Webhook URL if configured
⌘I
