Render a document from JSON (temporary)
curl --request POST \
--url https://api.autype.com/api/v1/dev/render \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"config": {
"document": {
"type": "pdf",
"size": "A4"
},
"variables": {
"companyName": "Acme Inc"
},
"sections": [
{
"id": "section-1",
"type": "flow",
"content": [
{
"type": "h1",
"text": "Hello {{companyName}}"
},
{
"type": "text",
"text": "This is a paragraph."
}
]
}
]
},
"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/render"
payload = {
"config": {
"document": {
"type": "pdf",
"size": "A4"
},
"variables": { "companyName": "Acme Inc" },
"sections": [
{
"id": "section-1",
"type": "flow",
"content": [
{
"type": "h1",
"text": "Hello {{companyName}}"
},
{
"type": "text",
"text": "This is a paragraph."
}
]
}
]
},
"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({
config: {
document: {type: 'pdf', size: 'A4'},
variables: {companyName: 'Acme Inc'},
sections: [
{
id: 'section-1',
type: 'flow',
content: [
{type: 'h1', text: 'Hello {{companyName}}'},
{type: 'text', text: 'This is a paragraph.'}
]
}
]
},
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/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/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([
'config' => [
'document' => [
'type' => 'pdf',
'size' => 'A4'
],
'variables' => [
'companyName' => 'Acme Inc'
],
'sections' => [
[
'id' => 'section-1',
'type' => 'flow',
'content' => [
[
'type' => 'h1',
'text' => 'Hello {{companyName}}'
],
[
'type' => 'text',
'text' => 'This is a paragraph.'
]
]
]
]
],
'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/render"
payload := strings.NewReader("{\n \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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/render")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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/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 \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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{
"jobId": "<string>",
"creditCost": 123,
"createdAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"filename": "<string>",
"error": "<string>",
"completedAt": "2023-11-07T05:31:56Z"
}Rendering
Render a document from JSON (temporary)
Submit a document JSON for rendering to PDF, DOCX, or ODT. This is a temporary render — the document JSON is not persisted and the render output expires. No document is created in your Autype workspace. Use POST /render/document/ to render a persistent document instead. Returns a job ID for status polling. Credits are charged on successful completion.
POST
/
api
/
v1
/
dev
/
render
Render a document from JSON (temporary)
curl --request POST \
--url https://api.autype.com/api/v1/dev/render \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"config": {
"document": {
"type": "pdf",
"size": "A4"
},
"variables": {
"companyName": "Acme Inc"
},
"sections": [
{
"id": "section-1",
"type": "flow",
"content": [
{
"type": "h1",
"text": "Hello {{companyName}}"
},
{
"type": "text",
"text": "This is a paragraph."
}
]
}
]
},
"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/render"
payload = {
"config": {
"document": {
"type": "pdf",
"size": "A4"
},
"variables": { "companyName": "Acme Inc" },
"sections": [
{
"id": "section-1",
"type": "flow",
"content": [
{
"type": "h1",
"text": "Hello {{companyName}}"
},
{
"type": "text",
"text": "This is a paragraph."
}
]
}
]
},
"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({
config: {
document: {type: 'pdf', size: 'A4'},
variables: {companyName: 'Acme Inc'},
sections: [
{
id: 'section-1',
type: 'flow',
content: [
{type: 'h1', text: 'Hello {{companyName}}'},
{type: 'text', text: 'This is a paragraph.'}
]
}
]
},
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/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/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([
'config' => [
'document' => [
'type' => 'pdf',
'size' => 'A4'
],
'variables' => [
'companyName' => 'Acme Inc'
],
'sections' => [
[
'id' => 'section-1',
'type' => 'flow',
'content' => [
[
'type' => 'h1',
'text' => 'Hello {{companyName}}'
],
[
'type' => 'text',
'text' => 'This is a paragraph.'
]
]
]
]
],
'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/render"
payload := strings.NewReader("{\n \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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/render")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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/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 \"config\": {\n \"document\": {\n \"type\": \"pdf\",\n \"size\": \"A4\"\n },\n \"variables\": {\n \"companyName\": \"Acme Inc\"\n },\n \"sections\": [\n {\n \"id\": \"section-1\",\n \"type\": \"flow\",\n \"content\": [\n {\n \"type\": \"h1\",\n \"text\": \"Hello {{companyName}}\"\n },\n {\n \"type\": \"text\",\n \"text\": \"This is a paragraph.\"\n }\n ]\n }\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{
"jobId": "<string>",
"creditCost": 123,
"createdAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"filename": "<string>",
"error": "<string>",
"completedAt": "2023-11-07T05:31:56Z"
}Authorizations
API Key (starts with ak_...)
Query Parameters
Enable strict validation mode (validates anchors, references, citations, abbreviations)
Body
application/json
Complete document JSON following the Autype document schema. Must include document (with type) and sections. May also include variables, defaults, abbreviations, citations, and style — all at the same level inside this object. The output format is determined by the document.type field (pdf, docx, or odt). Variable placeholders can use either {{varName}} or ${varName} syntax — both are accepted on input. See the Document JSON Syntax docs for the full schema reference.
Show child attributes
Show child attributes
Example:
{
"document": { "type": "pdf", "size": "A4" },
"variables": { "companyName": "Acme Inc" },
"sections": [
{
"id": "section-1",
"type": "flow",
"content": [
{
"type": "h1",
"text": "Hello {{companyName}}"
},
{
"type": "text",
"text": "This is a paragraph."
}
]
}
]
}
Optional webhook configuration. Receives a POST when the job completes or fails.
Show child attributes
Show child attributes
Response
Render job created
Render job ID for status polling
Available options:
PENDING, PROCESSING, COMPLETED, FAILED Available options:
PDF, DOCX, ODT Credit cost for this render job
Autype API download URL with signed token (only when completed). Supports direct browser download.
Filename for download
Error message if failed
⌘I