Poll an align job
curl --request GET \
--url https://cue.vibeset.ai/v1/align/jobs/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cue.vibeset.ai/v1/align/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/align/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/align/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/align/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/align/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cue.vibeset.ai/v1/align/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>",
"track_id": "<string>",
"job_id": "<string>",
"status": "complete",
"cached": true,
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"mix": {
"voiceover": true,
"classification": "voice",
"music_gain_db": -4.4,
"video_gain_db": 11.4,
"duck": {
"envelope_points": [
[
0,
20
],
[
1.2,
20
],
[
1.9,
0
],
[
4.8,
0
]
],
"envelope_hz": 40,
"speech_ranges": [
[
1.2,
4.8
],
[
9.5,
14.1
]
],
"depth_db": 20,
"attack_ms": 375,
"release_ms": 1425
}
}
}{
"video_id": "<string>",
"track_id": "<string>",
"job_id": "<string>",
"status": "processing",
"poll": "/v1/align/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"
}
}Sync
Poll an align job
Poll an align job returned by POST /v1/align. 202 while it is still running. 200
with the sync points once complete, plus job_id, status and cached. Billed once,
on completion.
GET
/
v1
/
align
/
jobs
/
{job_id}
Poll an align job
curl --request GET \
--url https://cue.vibeset.ai/v1/align/jobs/{job_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cue.vibeset.ai/v1/align/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/align/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/align/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/align/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/align/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cue.vibeset.ai/v1/align/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>",
"track_id": "<string>",
"job_id": "<string>",
"status": "complete",
"cached": true,
"sync_points": [
{
"offset_seconds": 123,
"score": 123,
"label": "<string>"
}
],
"mix": {
"voiceover": true,
"classification": "voice",
"music_gain_db": -4.4,
"video_gain_db": 11.4,
"duck": {
"envelope_points": [
[
0,
20
],
[
1.2,
20
],
[
1.9,
0
],
[
4.8,
0
]
],
"envelope_hz": 40,
"speech_ranges": [
[
1.2,
4.8
],
[
9.5,
14.1
]
],
"depth_db": 20,
"attack_ms": 375,
"release_ms": 1425
}
}
}{
"video_id": "<string>",
"track_id": "<string>",
"job_id": "<string>",
"status": "processing",
"poll": "/v1/align/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
Response
The finished alignment.
A completed align job, an AlignResult plus the job's own fields.
Available options:
complete Show child attributes
Show child attributes
Present only when auto_mix was true AND the measurement could be read. Unlike the synchronous AlignResult, the job OMITS this key rather than sending null.
Show child attributes
Show child attributes
Example:
{
"voiceover": true,
"classification": "voice",
"music_gain_db": -4.4,
"video_gain_db": 11.4,
"duck": {
"envelope_points": [[0, 20], [1.2, 20], [1.9, 0], [4.8, 0]],
"envelope_hz": 40,
"speech_ranges": [[1.2, 4.8], [9.5, 14.1]],
"depth_db": 20,
"attack_ms": 375,
"release_ms": 1425
}
}