Skip to main content
POST
get templates

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
id
string

The id the user copied in Explore, or one a listing returned.

ids
string[]

Several ids in one call: entries returns each in the order given, a miss reported beside its id. An answer stops at about 100,000 characters and names the rest in next_ids.

Required array length: 1 - 20 elements
query
string

Words for what is needed: "lower third with a photo". Returns the closest matches.

kind
enum<string>

One kind: graphic (alone it lists the shelves), caption, move (camera moves), timeline (video templates, ours then this workspace's), canvas (image templates, ours then this workspace's), filter, font (every family the renderer draws, with its weights and scripts).

Available options:
graphic,
caption,
move,
timeline,
canvas,
filter,
font
shelf
string

A graphics shelf by name, as a listing gives it: "Lower thirds". Lists its graphics.

code
boolean

With a graphic's id: include its source code.

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