All endpoints take Authorization: Bearer <key> and, where there is a body, JSON, unless
noted. The machine-readable description is the OpenAPI document served at /openapi.json
on the API host.
| Method and path |
Purpose |
POST /v1/render |
Render a PDF, or get a link to one. Costs a credit. Details. |
POST /v1/validate |
Check a document without rendering it for you. Free. Details. |
GET /v1/files/{id}?exp=…&sig=… |
Open a PDF from a signed link. Needs no key. |
| Method and path |
Purpose |
GET /v1/templates |
List your templates. |
POST /v1/templates |
Create a template. The source must compile. |
GET /v1/templates/{id} |
Read a template. |
PATCH /v1/templates/{id} |
Change fields of a template. Only the fields you send change. |
DELETE /v1/templates/{id} |
Delete a template. |
| Method and path |
Purpose |
POST /v1/assets?name=… |
Upload a PNG or JPEG. The body is the raw image. Details. |
GET /v1/assets |
List your images. |
DELETE /v1/assets/{id} |
Delete an image. |
| Method and path |
Purpose |
GET /v1/me |
Your plan, credits and the end of the current period. |
API keys are created and revoked in the portal, not through the API, so a leaked key cannot
mint more keys.