Skip to main content
POST
render 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 that is not hidden. For images a canvas with more than twelve of those is refused with how to ask for the rest, never trimmed; a pdf takes them all.

Maximum array length: 50
format
enum<string>

Default png. jpeg for a photograph where the file size matters. pdf is one file for the slides asked for, every slide by default, a page each: a LinkedIn document carousel or a deck leaves this way, an Instagram carousel as images.

Available options:
png,
jpeg,
pdf
scale
number

A multiple of the canvas's own size, drawn again at that size rather than enlarged. Default 1. It multiplies what the slide draws, so a 2x slide uses about four times the cloud processing of a 1x one.

Required range: 0.1 <= x <= 4
transparent
boolean

PNG only: draw the ground as transparent whatever the canvas says.

quality
number

JPEG only, 0.1–1. Default 0.9.

Required range: 0.1 <= x <= 1
title
string

What the file is called. Default: the canvas, and the slide where there is more than one.

Maximum string length: 120
folder
string

Library folder the finished files land in, by path ("campaigns/july"), name or id. It has to exist already. Left out, they land in Canvas exports.

context
string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

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