How it works

The parts

• API. What your application and Studio talk to. It checks every request, stores your templates and renders your documents.
• Studio. The web app for writing templates and managing the workspace. It uses the same API as your application.

Workspaces

A workspace owns everything you create: templates, files, renders, API keys and webhooks. Nothing is shared between workspaces. An API key works only in the workspace it was created in, and Studio shows the workspace you have selected.

People join a workspace as an owner, admin or member. Owners and admins manage keys, webhooks and teammates; see roles.

API keys and scopes

Applications prove who they are with an API key, a secret sent in the x-api-key header of every request. Owners and admins create keys in Studio under Manage → API keys. Each key has scopes, such as render:create or template:publish, that decide what it may do. Give each key only the scopes its application needs. The full list, expiry and rotation are in API keys, scopes and roles.

Templates, drafts and versions

A template is a reusable document: HTML with Handlebars placeholders, page settings, and the files it uses. You edit its draft and preview it in Studio. Publishing freezes the draft, and every file it uses, into a numbered version. Later edits never change a published version. See how templates work.

Two ways to render

• Reports API. Send a template’s name and your data. The response is the PDF or XLSX file, rendered from the newest published version.
• Renders API. Create a render job from one specific template version or from your own HTML, and get a PDF. Each render has an ID and moves from queued to processing, then ends succeeded, failed or cancelled. Wait for it in the request, poll it, or receive a webhook. Batches and cancelling are only here. See render states.

Next steps

• Quickstart: render your first PDF.
• Limits: every size, time and rate limit in one place.