Generate a document
Authorization
ApiKeyAuth API key from Settings → API Keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/renders" \ -H "Content-Type: application/json" \ -d '{ "template_id": "cm4tpl8e20001js04xq2v9k3m", "data": { "invoice_number": "INV-0042", "client_name": "Acme Corp", "amount": "$4,200" }, "visibility": "public" }'{ "id": "cm4rnd7qh0001jx04w8e2t5va", "self": "https://automette.com/api/v1/renders/cm4rnd7qh0001jx04w8e2t5va", "status": "completed", "url": "https://cdn.automette.com/p/cm4rnd7qh0001jx04w8e2t5va/document.pdf", "format": "pdf", "template_id": "cm4tpl8e20001js04xq2v9k3m", "template_name": "Invoice", "data": { "invoice_number": "INV-0042", "client_name": "Acme Corp" }, "created_at": "2026-04-22T12:00:00.000Z"}List renders GET
Returns renders for your team, newest first. Supports cursor-based pagination. To paginate, pass the `next_cursor` from one response as the `cursor` in the next request. `next_cursor` is `null` when there are no more pages.
Get a render GET
Returns the current status of a render. Poll this endpoint after an async `POST /api/v1/renders` until `status` is `completed` or `failed`. **`status`** transitions: `pending` → `running` → `completed` or `failed`. While not `completed`, `url` is `null`. **`error`** is populated when `status` is `failed`. Truncated to 500 characters. **`webhook_deliveries`** lists every attempt to deliver a webhook for this render, including retries. `source` is `render_webhook` (per-request `webhook_url`) or `global_webhook` (subscription). `null` if no deliveries have been attempted yet. **Download mode** — add `?download=true` to redirect directly to the file. For public renders, redirects to the CDN URL. For secure renders, generates a short-lived (15-minute) presigned S3 URL. Useful for `<a href>` tags or `curl -OL`. When multiple formats were requested, add `?format=pdf`, `?format=png`, etc. to pick which file to download. Defaults to the first file if omitted.