Skip to main content
POST
remove words

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.

words
(integer | object)[]

Word indices from get_transcript; a [start, end] pair cuts that whole span.

matches
string[]

Cut every occurrence of these single words (case and punctuation insensitive). For a phrase, pass its word indices from get_transcript as a [start, end] span.

cut_aggressiveness
enum<string>

Room left either side of a removed word: tight is flush (default), balanced about 67ms, loose about 167ms. Loose sounds more natural; tight for words that butt together.

Available options:
tight,
balanced,
loose
source
enum<string>

The speech the indices came from: pass the same source you read get_transcript with (all included), or indices land on the wrong stream.

Available options:
voiceover,
dialogue,
music,
auto,
all
if_revision

The revision get_timeline returned. A stale one fails with revision_conflict instead of applying; so does no revision once a user edited the timeline in the app since this connection last read it.

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