Skip to main content
POST
timeline 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
timeline_id
string
required

The timeline id.

attach
string[]

Items to attach as media; a document item is kept as a doc whatever role is given.

An item ref, item id, or the job id that made it.

role
enum<string>

How the attached items are kept: media (default) or doc, for notes and scripts the user wants beside the timeline.

Available options:
media,
doc
detach
string[]

Items to let go of. Items the cut still uses stay and come back as in_use.

An item ref, item id, or the job id that made it.

detach_unused
boolean

Let go of everything the cut does not use, in one act: the way back from gathering more than the piece needed. Docs are never swept.

limit
integer

Items per page of the list. Default 50.

Required range: 1 <= x <= 200
cursor
string

next_cursor from the answer before: the next page of the set.

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