Skip to main content
POST
cURL

Authorizations

apiKey
string
query
required

Query Parameters

stream
string

true streams the progress as server-sent events.

Example:

"true"

Body

application/json
apiKey
string
required

Your API key. Create one on the API Keys page of the dashboard, and keep it on the server.

Example:

"YOUR_API_KEY"

templateId
string
required

The id of the template to render. In the dashboard, open the menu on a template card and choose Copy Template ID.

Example:

"tpl_xxx"

modifications

The values to change in the template, as an array of modifications. Each modification names a layer and sets one or more fields, and a layer without a modification keeps the values from the template. An object keyed by layer name and a JSON string of either shape also work. See https://bannerify.co/docs/essentials/modifications.

Example:

Response

The stored video, or the events of its render.

url
string
required

The public URL of the MP4.

Example:

"https://images.bannerify.co/files/0b3c1c1e-5d6f-4c52-9e0a-8f6a4c0f2a11.mp4"