Skip to main content
GET
Get a canvas design (includes the current HTML for the preview).

Authorizations

X-API-Key
string
header
required

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

Path Parameters

canvas_id
string
required

Response

Canvas design

Canvas design

id
string

Canvas ID

companyId
string

Company ID

name
string

Canvas name

width
integer

Canvas width in pixels

height
integer

Canvas height in pixels

format
string

Named canvas format id, when the size came from one

htmlContent
string

The standalone HTML document for the canvas

animated
boolean

Whether the canvas is animated (exports a looping MP4 instead of a PNG)

videoDuration
number

Loop length in seconds for animated canvases

imageId
string

Images table id of the last render

imageUrl
string

Public PNG URL of the last render

videoId
string

Videos table id of the last recording (animated canvases)

videoUrl
string

Public MP4 URL of the last recording (animated canvases)