Automette docs
API Reference

Browse the template library

GET
/api/v1/library_templates

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from Settings → API Keys.

In: header

Query Parameters

engine?string

Value in

  • "typst"
  • "canvas"
  • "docx"
category?string
q?string

Matches the name, category, slug, description, what the template is recommended for, and its field names — so q=training completion finds the certificates, not nothing. Every word must match, so extra words narrow the result rather than widening it.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/library_templates"
{  "library_templates": [    {      "slug": "invoice-minimal",      "name": "Minimal Invoice",      "category": "invoice",      "engine": "typst",      "fields": [        "customer",        "invoice_no",        "total"      ],      "description": "A plain invoice with a line-item table.",      "recommended_for": "Billing customers, professional services",      "preview_url": null,      "preview_pdf_url": "https://files.automette.com/...",      "thumbnail_url": "https://files.automette.com/...",      "self": "https://automette.com/api/v1/library_templates/invoice-minimal"    }  ]}

Delete a font DELETE

Removes the font. Templates that still name it keep rendering but in a substitute face, so run validate on them afterwards.

Get a library template GET

One library template in full, including its `document` — a working example of the engine, which is the cheapest way to learn either format. To use it, **do not** copy the `document` into a create call. POST to `/api/v1/templates` with `{ "from_library": "<slug>" }`. Copying the document alone leaves the images behind: canvas stores the source template's storage keys inside the document, so the copy renders someone else's assets until they are deleted, and then renders nothing.