Skip to main content
POST
get canvas

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
canvas_id
string

Leave it out to list the workspace's canvases instead of reading one.

find_text
string

With no canvas_id: only the canvases whose text layers hold these words, whatever the case, each with the layers that do.

Required string length: 2 - 200
slide

One slide, by id or by its place from 0. Default: every slide.

layer_ids
string[]

Only these layers, wherever they sit, groups walked into.

Maximum array length: 200
types
enum<string>[]

Only these kinds of layer; "text" alone is how a translation reads a canvas.

Available options:
image,
text,
shape,
icon,
chart,
group,
adjustment
response_format
enum<string>

concise (default): each layer's id, name, kind, box and key facts. detailed: the stored layers whole. shape: the canvas's size and slides without layers.

Available options:
concise,
detailed,
shape
history
integer

Include this many saved versions, newest first.

Required range: 1 <= x <= 50
destinations
boolean

Include the named sizes (Instagram post, YouTube thumbnail, A4…) with their ids and pixels; works with or without canvas_id.

limit
integer

Listing only: canvases per page. Default 50.

Required range: 1 <= x <= 100
cursor
string

next_cursor from the answer before, with the other fields the same: the next page of the list, or the rest of a canvas a read cut short.

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]