Skip to main content
POST
Loop a track across a long video

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vbsk_live_...

Headers

Idempotency-Key
string

Suppresses a DUPLICATE BILLING ROW for a retry of this exact request. It does not return the earlier response and does not stop the loop re-running.

Body

application/json
video_id
string
required

A long video you own (or a shared/seed clip).

Maximum string length: 128
track_id
string
required

The Soundstripe track to loop, as returned by /v1/match.

Maximum string length: 128
auto_mix
boolean
default:false

When true, an APPLICABLE loop also carries a mix block, the duck-under-voiceover spec described by the Mix schema. There is no mix key on a not-applicable result, or when the measurement could not be read.

Response

The loop plan for the track, or an applicable: false refusal.

video_id
string
track_id
string
track
object

The catalog identifiers for the recording a loop plan describes. The song is the work, the audio file is the specific render you fetch. They are not interchangeable.

applicable
boolean

False when there is nothing to loop. Then plan explains why, hint says it in words, retryable says whether calling again can help, and nothing is billed.

plan
object

How to lay the track under the clip. segments is the authoritative playback path. loop_start_a / loop_end_b / repeats describe the same loop but cannot express a final pass that exits into a come-down outro. On a not-applicable result only applicable, reason and (for video_not_longer) the three duration fields are present.

hint
string

Present only when applicable is false, a plain-language reason and what to do.

retryable
boolean

Present only when applicable is false. True for timeout, profile_error, missing_profile and audio_unavailable: nothing was cached, so calling again in a few seconds normally reads back work that finished in the background. False means the answer is settled: pick another track.

mix
object

Auto-mix (duck-the-music-under-the-voiceover) spec, returned when auto_mix is true. These are the same numbers the Cue app's Loop/Sync preview + export use, so a render with them matches the app. Applicable to whatever music you lay under the clip.

Example: