Skip to main content
POST
manage timelines

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
list
boolean

The workspace's timelines, newest edit first.

find_text
string

Words to find in every timeline, whatever the case: an old tagline, a misspelled name. Returns each timeline holding them with every title, caption, graphic, chapter and note that does.

Required string length: 2 - 200
create
object
template
object

Keep a timeline as a starting shape, or stop. Its pictures and its titles become the holes a copy fills; clear the ones that should stay, and say what belongs in each with edit_timeline updateClip placeholder.

rename
object
settings
object

Composition size in pixels (setAspectRatio on edit_timeline is the shorthand for the standard sizes) and frame rate.

open
object

Show this timeline in the user's editor as a tab, switched to. The call cannot tell whether an editor is open to receive it.

delete
object

Take a timeline away for good. There is no trash. A clip of a project goes on its own; a project goes with its clips only when whole_project says so, and its post leaves the feed with it.

limit
integer

Listing only: timelines per page. Default 50.

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

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

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