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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json
list
boolean

The workspace's timelines.

name
string

With list: only timelines whose name contains this, any case.

Required string length: 1 - 200
starred
boolean

Clips and timelines favorited on their feed post, latest first, with starred_at.

find_text
string

Words to find inside timelines, whatever the case: an old tagline, a misspelling. Not their names: list with 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

Make a timeline a template, or stop. Its pictures and titles become the holes a copy fills; unmark the ones that stay fixed, and say what belongs in each with edit_timeline updateClip placeholder.

rename
object
pin
object

Put a project first on the user's Edit page, for the whole workspace, or unpin it. A timeline inside a project pins its project.

settings
object

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

move
object

Move a timeline to another tab of its project; those between shift and their names follow, ids unchanged. Timeline 1 is the project and stays first.

open
object

Show this timeline in the user's editor as a tab, switched to; the editor opens on a computer, not a phone. 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 project's timelines are numbered by place, so later ones move up and their names follow. A project goes whole only with whole_project, 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.

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