Integrating

These guides show how to call the generation API from your own system. Every request is a curl command, with the API’s address and your key in $PAPRIKA_URL and $PAPRIKA_KEY (see Authentication); in your code, send the same requests with any HTTP client. Every route is described in full in the API reference.

• Authentication: sending your key, scopes, and managing keys.
• Templates: publishing a template, its versions, and what it takes.
• Rendering: a PDF or an image, straight away or kept as an output.
• Images and resources: images of your own in the values.
• Policy: what a render does when the text doesn’t fit.
• Jobs and webhooks: rendering in the background, and being told when it’s done.
• Batches: many records of one template, combined as one PDF or a ZIP.
• Brand kits: your organisation’s colours, styles and images.
• Errors and versioning: what goes wrong, what to retry, and how the API changes.
• Fonts and rights: which fonts a render can use.

To try it first, start with Render it from the API. Values gives the rules a template’s fields hold values to.