API reference
Every endpoint, generated from the OpenAPI 3.1 document at /openapi.json.
The pages in this section are generated from /openapi.json at build time; each one documents the request, the responses and example calls in several languages, with a "try it" panel.
Prefer a single scrolling page with a built-in HTTP client? The API server hosts a Scalar reference at /reference ("Interactive reference").
Compile
POST /v1/compile
Compile a project synchronously.
POST /v1/demo/compile
Compile without an API key (playground).
Jobs
POST /v1/jobs
Create an asynchronous compile job.
GET /v1/jobs/{id}
Get a job.
DELETE /v1/jobs/{id}
Cancel a queued or running job.
GET /v1/jobs/{id}/events
Stream job events (SSE).
GET /v1/jobs/{id}/pdf
Download the PDF.
GET /v1/jobs/{id}/log
Download the full LaTeX log.
Templates
GET /v1/templates
List templates.
GET /v1/templates/{id}
Get a template and its file list.
GET /v1/templates/{id}/files/{path}
Read one template file.
GET /v1/templates/{id}/archive
Download the template as a zip.
GET /v1/templates/{id}/preview
Rendered PDF of the untouched template.
POST /v1/templates/{id}/compile
Compile a template with your changes.
POST /v1/templates/{id}/jobs
Compile a template asynchronously.