Skip to main content
GET
/
v1
/
templates
/
signedurl
cURL
curl --request GET \
  --url 'https://api.bannerify.co/v1/templates/signedurl?apiKey='
"<string>"

Documentation Index

Fetch the complete documentation index at: https://documentation.bannerify.co/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
apiKey
string
query
required

Query Parameters

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

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

​
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
string

A JSON string of modifications object

​
thumbnail
boolean | null
default:false

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

Response

A image file

The binary of image file