Videos

Set background music

Sets the video's background music track. It loops over the whole video and is included in exports. Volume is 0-1 and defaults to 0.2.

put/v1/videos/{id}/background-music

Request

  • Base URL: https://api.tella.com
  • URL: https://api.tella.com/v1/videos/{id}/background-music
  • Auth: HTTP bearer

Path parameters

idstring required

Unique video identifier

Example:vid_abc123def456

Request body

namestring

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

presetIdstring

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; exactly one is required.

sourceIdstring

Audio source ID from POST /v1/sources (kind: "audio"). Mutually exclusive with presetId; exactly one is required.

volumenumber

Track volume from 0 (silent) to 1 (full volume)

Example request

{
  "name": "Calm Product Tour",
  "presetId": "calm-product-tour",
  "sourceId": "su_abc123def456",
  "volume": 0.2
}

Response

Background music set

Example response

{
  "backgroundMusic": {
    "durationMs": 180036,
    "name": "Calm Product Tour",
    "url": "https://ucarecdn.com/example-track/",
    "volume": 0.2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.