Skip to main content
POST
upscale media

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
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
media_type
enum<string>

Force the branch when the ref's type cannot be trusted. The video branch prices on the length it is handed and is refused outright when no duration can be read from the item or the file.

Available options:
image,
video
timeline_id
string

With clip_id: only that clip's trimmed stretch is upscaled, and the result takes its slot when it lands. Alone: the result is attached to this timeline.

clip_id
string

With timeline_id: the clip whose trimmed stretch is upscaled and whose slot the result takes.

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