API overview

The Imprime API has one job: turn a template plus your data into a PDF. You design templates in the editor, then call the API to generate documents at scale.

Base URL

https://app.imprime.io/api

On a self-hosted instance, the base URL is <PUBLIC_APP_URL>/api — for example https://imprime.example.com/api.

Authentication

Send an API key in the x-api-key header:

curl https://app.imprime.io/api/templates \
  -H "x-api-key: $IMPRIME_API_KEY"

Requests run as the owner of the key: you only ever see and generate your own templates. Asking for someone else’s template returns 404, exactly as if it didn’t exist.

Note

In the browser, the editor authenticates with a session cookie instead. For integrations, use an API key.

Endpoints

Method	Path	Description
POST	/export/{id}/pdf	Generate a PDF from a template
GET	/templates	List your templates
GET	/templates/{id}	Get one template and its variables
GET	/health	Health check (public)

Caution

The API is read-and-generate. Editing a template — its pages, shapes and layout — is done in the editor, not over HTTP. Routes that mutate template content are not part of the public API and may change or disappear without notice.

Conventions

• Request and response bodies are JSON, except the PDF export, which returns application/pdf.
• IDs are 24-character hexadecimal strings (6ada52d12b452e53f3c518e3).
• Errors share one format — see Errors.

Start here

Export a PDFThe endpoint most integrations need — and often the only one.

TemplatesList your templates and read their variables.