Skip to main content
PUT
Set background music

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Unique video identifier

Example:

"vid_abc123def456"

Body

application/json

Set the video's background music from either your own uploaded audio (sourceId) or Tella's curated catalog (presetId), or change the current track's volume or name

name
string

Optional display name for the track. Defaults to the preset's name when presetId is given.

Example:

"Calm Product Tour"

presetId
string

Preset ID of a curated Tella music track, from a default item of type music in GET /v1/library. Nothing to upload. Mutually exclusive with sourceId. Omit both to keep the current track and change only its volume or name.

Example:

"calm-product-tour"

sourceId
string

Audio source ID from POST /v1/sources (kind: "audio"). Mutually exclusive with presetId. Omit both to keep the current track and change only its volume or name.

Example:

"su_abc123def456"

volume
number

Track volume from 0 (silent) to 1 (full volume). Defaults to 0.2 for a new track, and to the current track's volume when neither sourceId nor presetId is given.

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

0.2

Response

Background music set

backgroundMusic
object
required

One video-wide track that loops over the whole video and is included in exports