Skip to main content
GET
cURL
The signed URL endpoint allows you to generate customized images with dynamic data on the URL. Use this endpoint to create personalized visuals or dynamic images for various purposes, such as marketing campaigns or user-specific content. It’s recommended to use this via an SDK. The URL carries a signature made with your API key. The signature covers the template and every other parameter, so a signed URL is safe to share: anyone holding it can render that image, but nobody can change the template or the modifications in it.

Authorizations

apiKey
string
query
required

Query Parameters

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

By default, we cache the image in the CDN for 1 day to save your bandwidth, use this field to disable cache so you can get the latest image

Example:

"true"

_debug

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.

templateId
string
required

Your template id

Example:

"tpl_xxxxxxxxx"

apiKeyMd5
string
deprecated

MD5 hash of the API key

apiKeyHashed
string

Sha256 hash of the API key (use this)

sign
string
required

SHA256 hash of the query params, read more at https://bannerify.co/docs/api-reference/endpoint/signed-url

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 columns.

Example:
thumbnail
default:false

Generate thumbnail preview (low-quality, non-billable)

Response

A image file

The binary of image file