Skip to main content
POST
clean audio

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
ref
string
required

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

mode
enum<string>

denoise (default): lower the noise floor, keep everything else. isolate_voice: keep only the speech; removes reverb and music.

Available options:
denoise,
isolate_voice
strength
number

denoise only: how much of the cleaned sound to keep, 0 to 1. Default 1.

Required range: 0 <= x <= 1
timeline_id
string

With clip_id: the result is attached to this timeline and takes the clip's slot when it lands.

clip_id
string

The clip on timeline_id whose sound this replaces, audio or video; the clip decides the shape of the result.

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