Five objects power everything in PixlDocs.
Template
An HTML document with Liquid placeholders and its own CSS, stored in your workspace. It carries design and page setup — paper size, orientation, margins, running headers — never end-user data.
Field contract
The @field declarations at the top of a template are its public API: those keys, and no others, are accepted. GET /v1/templates/:id/fields returns them, and a key the template cannot bind is refused with 400 unknown_fields rather than silently dropped.
Render
The output artifact — a PDF, PNG or WebP produced from a template plus data. Renders are stored in your workspace and served through the CDN. A render costs credits per page; a render that fails after being charged is refunded automatically.
API key
One key type, pxd_, on every plan. It is scoped to a single workspace and renders only the templates in that workspace. Renders are never watermarked. Volume is limited by credits; request rate is set by your account tier.
Workspace
The container for your templates, renders, members and keys. Every account has a personal workspace; team plans support multiple members.
Ownership rules
- Every
templateandrenderbelongs to exactly one workspace. - A key can never touch another workspace's resources — a template id from outside returns
403 template_forbidden. - Opening a public document copies it into your workspace; the original stays untouched.