Skip to main content
POST
cURL

Authorizations

apiKey
string
query
required

Body

application/json
apiKey
string
required
templateId
string
required

Your template id

Example:

"tpl_xxxxxxxxx"

format
enum<string>
default:png
Available options:
png,
jpeg,
webp
_debug
string

Only for debug purpose, it draws bounding box for each layer

s3Config
object

Optional custom S3 configuration. If provided, the generated file will be stored in your S3-compatible storage instead of the default Bannerify storage.

modifications

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.

Example:
thumbnail
boolean | null
default:false

Generate thumbnail preview (non-billable)

Response

A image file

The binary of image file