Skip to main content
POST
/
generations
Trigger a generation
curl --request POST \
  --url https://api.platendoc.com/v1/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "<string>",
  "variables": {},
  "format": "pdf"
}
'
{
  "id": "gen_abc123",
  "workspaceId": "ws_xyz",
  "templateId": "tpl_abc",
  "templateName": "Invoice",
  "data": {
    "customerName": "Acme Corp"
  },
  "outputUrl": "https://cdn.platendoc.com/gen_abc123.pdf",
  "error": "<string>",
  "createdAt": "2026-05-07T10:00:00.000Z",
  "updatedAt": "2026-05-07T10:00:05.000Z"
}

Authorizations

​
Authorization
string
header
required

API key with pdc_live_ prefix. Pass as: Authorization: Bearer pdc_live_xxx

Body

application/json
​
templateId
string
required
Minimum string length: 1
​
variables
object
​
format
enum<string>
default:pdf
Available options:
pdf

Response

Generation created.

​
id
string
required
Example:

"gen_abc123"

​
workspaceId
string
required
Example:

"ws_xyz"

​
templateId
string
required
Example:

"tpl_abc"

​
templateName
string
required
Example:

"Invoice"

​
format
enum<string>
required
Available options:
PDF
​
status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
data
object
required
Example:
{ "customerName": "Acme Corp" }
​
outputUrl
string<uri> | null
required
Example:

"https://cdn.platendoc.com/gen_abc123.pdf"

​
error
string | null
required
​
createdAt
string<date-time>
required
Example:

"2026-05-07T10:00:00.000Z"

​
updatedAt
string<date-time>
required
Example:

"2026-05-07T10:00:05.000Z"