Skip to main content
POST
manage settings

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
video_model
string

The model a video generation uses when none is named. Ids come from list_models.

image_model
string

The model an image generation uses when none is named.

music_model
string

The model generate_audio uses for music when none is named. Voiceover and sound effects have one provider each.

timezone
string

This user's time zone as an IANA name (Europe/London, America/New_York). It decides what "today" and "this month" mean in calendars.

workspace_name
string

Rename this workspace, up to 60 characters.

Maximum string length: 60
workspace_icon
string | null

An image in the library, by id or ref, made this workspace's icon. null removes it and the name's first letter is drawn instead.

file_new_items
object

Per kind, whether a new item with no folder chosen is filed into the app's own folder for it. All on unless switched off; a kind set false lands at the top level. Pass only the kinds that change.

When a public link is taken down, a file the link itself put in the cloud drops that copy, if a machine still holds it and nothing else needs it. On unless switched off.

sync_files_to_cloud
boolean

Files on a desktop also go to the cloud while the owner's storage has room, so the web, phones, members and cloud agents can use them. On unless switched off; off keeps new files on the computer they came from.

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