Automette docs
API Reference

List templates

GET
/api/v1/templates

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from Settings → API Keys.

In: header

Query Parameters

engine?string

Filter by template engine. Any value other than typst, canvas, or docx returns 422.

Value in

  • "typst"
  • "canvas"
  • "docx"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/templates"
[  {    "id": "cm4tpl8e20001js04xq2v9k3m",    "name": "Invoice",    "engine": "typst",    "self": "https://automette.com/api/v1/templates/cm4tpl8e20001js04xq2v9k3m",    "created_at": "2026-04-01T09:00:00.000Z",    "updated_at": "2026-04-22T11:00:00.000Z"  }]

API Reference

Conventions, base URL, errors, and versioning for the Automette REST API.

Get a template GET

Returns a single template including its `available_fields` — the keys you can pass in the `data` object of `POST /api/v1/renders`. **Field schema by engine:** - **Typst / Canvas** — keys extracted from the template source: `{ key, type: "text", example }` where `example` is the placeholder value in the source. - **DOCX** — the template's authored field definitions with richer metadata: `{ key, label, type, required }` where `type` is one of `text`, `date`, `number`, or `array`. Also returns `url_base` — the template's on-demand URL token, or `null` if not generated yet. See [On-demand URLs](/docs/api/on-demand-urls).