Sign an on-demand URL
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
curl -X POST "https://example.com/api/v1/sign" \ -H "Content-Type: application/json" \ -d '{ "template_id": "cm4tpl8e20001js04xq2v9k3m", "data": { "name": "Alice", "amount": "1,200" } }'{ "url": "https://automette.com/ondemand/Yx4kPz8qWm2nRv6t/image.pdf?data=...&s=...", "template_name": "Invoice", "format": "pdf", "url_base": "Yx4kPz8qWm2nRv6t"}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.
List webhook subscriptions GET
Returns all webhook subscriptions for your team. `failure_count` is the rolling count of consecutive failed delivery attempts. Automette auto-disables a subscription after **10 consecutive failures** — PATCH `enabled: true` to re-arm it and reset the counter.