Skip to main content
POST
inspect 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
required

The canvas id.

slides
(string | integer)[]

Which slides, by id or by place from 0. Default: every slide, up to twelve.

Maximum array length: 12
grid
boolean

False to leave the grid off and return the bare picture. Default true.

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[]