Poll a match job
curl --request GET \
--url https://cue.vibeset.ai/v1/match/jobs/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cue.vibeset.ai/v1/match/jobs/{job_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cue.vibeset.ai/v1/match/jobs/{job_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cue.vibeset.ai/v1/match/jobs/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cue.vibeset.ai/v1/match/jobs/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cue.vibeset.ai/v1/match/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cue.vibeset.ai/v1/match/jobs/{job_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"video_id": "<string>",
"job_id": "<string>",
"status": "complete",
"lane": {
"title": "<string>",
"reasoning": "<string>",
"matches": [
{
"track_id": "<string>",
"audio_id": "<string>",
"soundstripe_song_id": "<string>",
"soundstripe_audio_file_id": "<string>",
"score": 123,
"bpm": 123,
"instrumental": true,
"duration_seconds": 123,
"sync_status": "warm",
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"title": "<string>",
"artist_name": "<string>",
"artist_image_url": "<string>",
"description": "<string>",
"energy": 123,
"musical_key_name": "<string>",
"musical_key_mode": "<string>",
"explicit": true,
"matched_tags": [
"<string>"
],
"fit_explanation": "<string>",
"match_map": [
{
"video": "<string>",
"audio": "<string>",
"score": 123,
"category": "<string>"
}
],
"preview": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"format": "mp3",
"duration_seconds": 123
}
}
],
"candidate_pool": [
{
"track_id": "<string>",
"audio_id": "<string>",
"soundstripe_song_id": "<string>",
"soundstripe_audio_file_id": "<string>",
"score": 123,
"bpm": 123,
"instrumental": true,
"duration_seconds": 123,
"sync_status": "warm",
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"title": "<string>",
"artist_name": "<string>",
"artist_image_url": "<string>",
"description": "<string>",
"energy": 123,
"musical_key_name": "<string>",
"musical_key_mode": "<string>",
"explicit": true,
"matched_tags": [
"<string>"
],
"fit_explanation": "<string>",
"match_map": [
{
"video": "<string>",
"audio": "<string>",
"score": 123,
"category": "<string>"
}
],
"preview": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"format": "mp3",
"duration_seconds": 123
}
}
]
}
}{
"video_id": "<string>",
"job_id": "<string>",
"status": "processing",
"poll": "/v1/match/jobs/run_9f2c",
"next": "<string>"
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}Match
Poll a match job
Poll a match job returned by POST /v1/match. 202 while it is still running. 200
with the lane once complete, plus job_id and status. Billed once, on completion, and
polling is free.
include_sync and sync_points_per_track default to whatever the submit asked for.
Passing them here overrides that for this poll.
GET
/
v1
/
match
/
jobs
/
{job_id}
Poll a match job
curl --request GET \
--url https://cue.vibeset.ai/v1/match/jobs/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cue.vibeset.ai/v1/match/jobs/{job_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cue.vibeset.ai/v1/match/jobs/{job_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cue.vibeset.ai/v1/match/jobs/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cue.vibeset.ai/v1/match/jobs/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cue.vibeset.ai/v1/match/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cue.vibeset.ai/v1/match/jobs/{job_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"video_id": "<string>",
"job_id": "<string>",
"status": "complete",
"lane": {
"title": "<string>",
"reasoning": "<string>",
"matches": [
{
"track_id": "<string>",
"audio_id": "<string>",
"soundstripe_song_id": "<string>",
"soundstripe_audio_file_id": "<string>",
"score": 123,
"bpm": 123,
"instrumental": true,
"duration_seconds": 123,
"sync_status": "warm",
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"title": "<string>",
"artist_name": "<string>",
"artist_image_url": "<string>",
"description": "<string>",
"energy": 123,
"musical_key_name": "<string>",
"musical_key_mode": "<string>",
"explicit": true,
"matched_tags": [
"<string>"
],
"fit_explanation": "<string>",
"match_map": [
{
"video": "<string>",
"audio": "<string>",
"score": 123,
"category": "<string>"
}
],
"preview": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"format": "mp3",
"duration_seconds": 123
}
}
],
"candidate_pool": [
{
"track_id": "<string>",
"audio_id": "<string>",
"soundstripe_song_id": "<string>",
"soundstripe_audio_file_id": "<string>",
"score": 123,
"bpm": 123,
"instrumental": true,
"duration_seconds": 123,
"sync_status": "warm",
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"title": "<string>",
"artist_name": "<string>",
"artist_image_url": "<string>",
"description": "<string>",
"energy": 123,
"musical_key_name": "<string>",
"musical_key_mode": "<string>",
"explicit": true,
"matched_tags": [
"<string>"
],
"fit_explanation": "<string>",
"match_map": [
{
"video": "<string>",
"audio": "<string>",
"score": 123,
"category": "<string>"
}
],
"preview": {
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"format": "mp3",
"duration_seconds": 123
}
}
]
}
}{
"video_id": "<string>",
"job_id": "<string>",
"status": "processing",
"poll": "/v1/match/jobs/run_9f2c",
"next": "<string>"
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}{
"error": {
"type": "invalid_request",
"message": "Provide either 'video_id' or 'video_url'.",
"request_id": "a1b2c3d4e5f6"
}
}Authorizations
bearerAuthapiKeyAuth
Your API key as a Bearer token, e.g. Authorization: Bearer vbsk_live_...
Path Parameters
Query Parameters
Required range:
1 <= x <= 12Available options:
full