Skip to main content
POST
Add a sound effect to a clip

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Video identifier

Example:

"vid_abc123def456"

clipId
string
required

Clip identifier

Example:

"cl_xyz789ghi012"

Body

application/json

Add a sound effect to a clip, from Tella's curated catalog (presetId) or from your own audio (sourceId).

durationMs
integer
required
Required range: 0 < x <= 9007199254740991
Example:

3000

startTimeMs
integer
required

Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.

Required range: 0 <= x <= 9007199254740991
Example:

1000

name
string
Example:

"Whoosh"

presetId
string

Preset ID of a curated Tella sound effect, from a default item in GET /v1/library?scope=default. Placing one copies the effect into a source owned by your workspace, so nothing needs uploading. Mutually exclusive with sourceId; exactly one is required.

Example:

"cha-ching"

sourceId
string

Source ID for the audio, from POST /v1/sources (kind: audio with the audio's duration) or from a private/workspace item in GET /v1/library?type=sound-effect. When uploading, send the audio file as-is — MP3, WAV, M4A, … — no need to wrap it in an MP4. Mutually exclusive with presetId; exactly one is required.

Example:

"su_abc123"

volume
number

Playback volume (0 = muted, 1 = original). Defaults to 1.

Required range: x >= 0
Example:

1

Response

OK

A sound effect on a clip

soundEffect
object
required

A sound effect on a clip.