Skip to main content
POST
Get sync points for a track

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 alignment re-running.

Body

application/json
video_id
string
required

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

Maximum string length: 128
track_id
string
required

The track to align, the Soundstripe song id, as returned by /v1/match.

Maximum string length: 128
top_k
integer
default:12

How many sync points to return.

Required range: 1 <= x <= 50
auto_mix
boolean
default:false

When true, also return a mix block: if the video has a voiceover, how to duck the music under it (see the Mix schema). Off ⇒ no mix key in the response.

Response

Sync points for the track, best first.

video_id
string
track_id
string
cached
boolean

True when this pairing was served warm (billed at the lower rate).

sync_points
object[]
mix
object | null

Present only when auto_mix was true. Null when the measurement could not be read. Auto-mix never fails the align call.

Example: