Create a PDF

This endpoint creates a PDF according to the provided instructions in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Optional flag, allows to disable creating download PDF url.

Body Params

The request body contains a list of pages. Each page has some boxes/dimensions defined that are required for printing and its elements

Some general remarks:

  • Each 'element type' takes different parameters, so it is best to checkout the schema instead of the example values.
  • All dimensions, sizes, positions are in mm, unless noted otherwise.
string

A base PDF document from which a new PDF document will be created.
Plano size, bleed and safety boxes, and elements will be preserved in a new document
for each page that is present in the base PDF.

Either a location of the external file (HTTP, must be publicly accessible) or a reference to the uploaded file/part in the request body (multipart upload only)

pages
array of objects
required
length ≥ 1

Description of the pages of the new PDF document.

pages*

Object describing the page and its elements.

bleed
object

Bleed box of the page (margins related to plano, default: 0).
Must be omitted for existing pages (pages from base PDF).

plano
object

Plano (content) size of the page.
Must be provided for new pages.
Must be omitted for existing pages (pages from base PDF).

safety
object

Safety zone of the page (margins related to plano, default: 0), used to calculate the art box in the PDF.
Must be omitted for existing pages (pages from base PDF).

elements
array

List of elements that should be added to the page (can be dropped or left empty for an empty page).

Depending on the element 'type', its other/required properties will vary.

elements
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json