Skip to main content
POST
reframe image

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
ref
string
required
aspect_ratio
enum<string>
required
Available options:
16:9,
9:16,
1:1,
4:3,
3:4,
21:9
idempotency_key
string
required

A key you mint per dispatch (a UUID). The same key on a retry returns the job already dispatched instead of charging again; a new attempt takes a new key.

Required string length: 1 - 200
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[]