Skip to main content
POST
Render a locked canvas template to a PNG.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Template and slot text to render

companyId
string
required

Company ID whose credits are billed for the call

templateId
string
required

Template ID from GET /api/v0/canvas/templates

slots
object
required

Slot text keyed by slot name, e.g. {"headline": "...", "supporting": "..."}. Required slots must be present; text over a slot's word limit is cut.

format
string

Named canvas format (same values as POST /api/v0/canvas, e.g. 'square', 'portrait', 'story', 'landscape'); default 'portrait'. Ignored when width/height are given.

width
integer

Custom width in px (200-2160); requires height

height
integer

Custom height in px (200-2160); requires width

brandKitId
string

Brand kit whose color palette and logo style the template; defaults to the company's default brand kit

photoUrl
string

Public https image URL for the template's photo zone (e.g. a stock search fullUrl); every template uses one, and without it the zone shows a brand pattern

Response

The rendered canvas with its public image URL

Rendered canvas

imageId
string

ID of the saved image (still canvases only)

videoId
string

ID of the saved video (animated canvases only)

url
string

Permanent public URL of the rendered PNG, or of the recorded MP4 when animated

width
integer

Rendered width in px

height
integer

Rendered height in px

duration
number

Video length in seconds (animated canvases only)