Skip to content
Paprika
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Start here
Overview
Design your first template
Render it from the API
Your first template with AI
Designing templates
Overview
The workspace
Keyboard shortcuts
Drafts and working offline
Packages
Text
Lists
Tab stops
Styles
Fonts
Pages
Frames
Arranging frames
Rulers, guides and snapping
Anchors and auto-size
Components
Images
Shapes and soft masks
Fills and strokes
Colour
Brand kits
Fields
Proofing
Print output
Publishing
Integrating
Overview
Authentication and API keys
Templates and versions
Rendering documents
Images in your values
When a document doesn't fit
Jobs and webhooks
Batches
Brand kits
Errors and versioning
Fonts and their rights
Running Paprika
Overview
How Paprika is put together
Install
Storage and the database
Tenants and API keys
Security
Scheduler and tiers
Metering
Fonts and their rights
Upgrading
Troubleshooting
Authoring with AI
Overview
Working with an assistant
Reference
Overview
Configuration
Glossary
MCP tools
Values
API
Overview
service
Overview
The editor's build and the engine rendering
This description of the API
templates
Overview
The tenant's templates
Make a template (a filename, a title)
A template, with its versions
Delete a template and its versions
Change a template's filename, title or policy
Publish a package as the next version
A version's details: fields, sample values, fonts, warnings
Delete a version
A version's package (the normalised .paprika file)
The JSON Schema of the values a version takes
Check values against a version, optionally laid out (?layout=true)
A version's first page as a PNG
Render a version: kept as an output (201), or answered directly with Accept
outputs
Overview
An output's file (PDF or ZIP); also by a signed link, with no key
Remove an output before it expires
A signed link to an output's file
One page's image of an image output
An output's report
jobs
Overview
The tenant's jobs, newest first, a page at a time
Submit a render to run in the background
A job's status, and its output when done
Cancel a job
batches
Overview
The tenant's batches, newest first, a page at a time
Submit many value records of one version, combined as a PDF or ZIP
A batch's status, counts and combined output
A batch's records, each a job
Cancel a batch's records not yet run
resources
Overview
The tenant's named resources
A resource's file
Upload an image as a named resource (values name it resource:<name>)
Remove a named resource
fonts
Overview
The tenant's font library: bundled and uploaded fonts with their rights
Add a font file (or a collection) to the library, asserting its rights
A library font's file
Remove an uploaded font from the library
Change an uploaded font's rights
webhooks
Overview
The tenant's webhook endpoints
Register a webhook endpoint
A webhook endpoint
Remove a webhook endpoint
Change an endpoint's URL, events or whether it is enabled
Rotate an endpoint's signing secret
Send an endpoint a ping event
An endpoint's deliveries, newest first
keys
Overview
The tenant's API keys
Issue a key with no more scopes than the caller has
Rotate a key: a new one, the old working on for a day
Revoke a key at once
usage
Overview
The tenant's usage per UTC day or month, and its storage
operator
Overview
Every tenant
Make a tenant
A tenant
Delete a tenant (restorable for the grace period, then purged)
Change a tenant's name, retention or tier
Restore a deleted tenant
Suspend a tenant: its keys stop working, its queued jobs are cancelled
Resume a suspended tenant
A tenant's keys
Issue a key for a tenant (with a tier, if any)
Revoke a tenant's key
Set or clear a key's tier
Every usage event, oldest first: a page at a time, or all as CSV or NDJSON
Every tenant's storage now, and measured daily
The scheduler's measures per tier
Rotate a tenant's key
The audit log
brandkits
Overview
The tenant's brand kits, without their items
Make a brand kit
A brand kit with its items and revision
Delete a brand kit; 409 kit-in-use when templates' latest versions use it, unless confirmed
Rename a brand kit or change its description (a new revision)
Add or replace a swatch, style, component or font of a brand kit (a new revision)
Remove an item of a brand kit; 409 kit-item-in-use when templates' latest versions use it, unless confirmed
The templates whose latest versions use an item of a brand kit
A brand kit image's file
Add or replace an image of a brand kit (a new revision)
Publish a new version of every template whose latest version used an older revision of the kit
Explanation
Overview
One engine, editor and output
How text is laid out
Colour and print
Designing and generating
Reproducible output
What Paprika doesn't do yet
Select theme
Dark
Light
Auto
Overview
service
Section titled “service”
Health and this description.
Operations
Section titled “Operations”
GET
/v1/health
GET
/v1/openapi.json
