API Reference
Find the right API reference family quickly
Use this hub to jump directly to the reference family you need: access and identity, rendering, templates and shared PDF options, or account and billing operations.
The docs site is broader and more explanatory than the machine readable OpenAPI documents. Use the docs pages here to understand route families, auth models, and workflow context. Use Swagger when you need the narrower generated contract for supported external integration surfaces.
If you are building PDF generation flows, start withthe rendering reference hub. It is the canonical rendering entry point and routes you to single render, accepted jobs, batch rendering, and shared options.
Start here when
You know the capability and need route specific contracts without browsing unrelated endpoints.
Canonical rendering entry
Start at the rendering hub for single render, accepted jobs, batch workflows, and shared PDF options.
Reference families
Access and identity, rendering, template/options, and account/billing each stay on dedicated canonical routes.
OpenAPI split
Use /docs for the PDF runtime contract and /docs/account for customer account routes.
OpenAPI Surface
Use the two Swagger documents for narrow machine readable contracts
Swagger is intentionally split by audience. It is not a complete mirror of every route family described on this docs site.
PDF runtime contract
Open /docs
Machine readable OpenAPI for the external PDF runtime surface: single render, render job retrieval, batch creation, batch status, downloads, and cancellation.
Customer account contract
Open /docs/account
Machine readable OpenAPI for account routes customers use: auth and session flows, profile and API keys, templates, usage visibility, GDPR account actions, and billing account operations.
- The docs site remains broader than Swagger and can describe route families, workflows, auth models, and caveats that are easier to explain narratively than in OpenAPI.
- Admin, ops, site, legal, webhooks, and public signed token confirmation or download flows are intentionally not part of the supported machine readable public OpenAPI surface.
- Some reference pages, such as billing and authentication, describe both customer account routes and related public signed token flows. In those cases, Swagger covers only the supported customer account subset.
Access And Identity
Choose the page for authentication context and credentials
Use these pages to set up rendering credentials, work with hybrid bearer authentication for signed in users, and confirm which auth model a route family expects.
For machine readable contracts, use /docs/account for customer account routes. Public signed token confirmation and download helpers described in the authentication docs are intentionally outside that OpenAPI surface.
Signed-in account routes
Open authentication reference
Login, refresh, logout, verification, recovery, MFA, profile, and GDPR routes that operate for signed in users with an in memory bearer access token and httpOnly refresh cookie.
Rendering credentials
Open API keys reference
Create, rotate, revoke, and review the keys used by rendering and batch create routes.
Rendering Surface
Use /api/rendering as the entry point for all rendering routes
Start at the rendering hub when your task involves creating one PDF, following accepted work, running batch jobs, or understanding shared rendering options.
For machine readable contracts, use /docs. It is intentionally limited to the PDF runtime API and does not try to document account, admin, or operational routes.
Recommended start
Open /api/rendering (canonical entry)
Use this entry point to pick single render, accepted jobs, batch rendering, or the shared PDF options reference.
Already know the create route?
Open single render reference
Go straight to the create contract for request fields, execution behavior, output modes, and status codes.
Template And Options Surface
Keep templates and shared options on dedicated reference pages
Use these pages for reusable template workflows and the shared PDF options object used across rendering routes.
Template lifecycle routes are customer account routes, so their machine readable contract lives under/docs/account, while the narrative render flow stays here in the docs site.
Reusable layouts
Open templates reference
Manage saved templates, version history, and rollback separately from render-create request contracts.
Shared render object
Open PDF options reference
Use one shared reference for layout, timing, watermark, metadata, and runtime controls used across render requests.
Account And Billing Surface
Use account and billing pages for ongoing operations
These pages cover subscription state, invoices, usage visibility, request history, and post-integration account operations.
Use /docs/account for the customer account OpenAPI subset. This docs section can still describe related public signed token billing flows when they are part of the user experience, even though those flows are not part of the supported public Swagger surface.