Navigation

API Documentation

Create pdf

POST/v1/templates/createPdfTry it

Use this endpoint to create a pdf file from a template.

Authorizations

apiKeystringqueryrequired

Body

application/json

apiKeystringrequired
templateIdstringrequired

Your template ID

Example: "tpl_xxx"

modificationsobject[] | object | string | null
Option 1 · object[]Option 2 · objectOption 3 · stringOption 4 · anyOption 5 · any

Template modifications as the API array format, an object shorthand, or a JSON string. Object values map to text by default, while nested objects keep fields such as src, qrcode, rows, or chart.

{
  "headline": "Summer sale",
  "photo": {
    "src": "https://example.com/photo.png"
  }
}
Show child attributes
namestringrequired

The layer name of the modification

Example: "Text 1"

colorstring

The color for the modification

Example: "#FF0000"

srcstring

The source image for the modification

Example: "https://example.com/image.jpg"

textstring

You can modify the text layer with this field

Example: "Hello World"

barcodestring

Modify the barcode layer content with this field

Example: "1234567890"

qrcodestring

Modify the qrcode layer content with this field

Example: "Some text"

chartobject

Update chart layer's data, follow chart.js data structure

visibleboolean

Set the visibility of the field

Example: true

starnumber

Star value

Example: 5

widthModeenum<string>

Table width mode

Available options: standard, adaptive

Example: "adaptive"

heightModeenum<string>

Table height mode

Available options: standard, adaptive

Example: "adaptive"

themeenum<string>

Table theme

Available options: NONE, DEFAULT, BRIGHT, SIMPLIFY, ARCO

Example: "NONE"

rowsnull[]

Table rows

columnsstring[]

Table columns

Response

200 application/pdf

Success create pdf

The binary of pdf file