Background Audio
Mint a presigned upload URL
Step 1 of the two-step upload: returns a 15-minute presigned PUT URL plus the id of a new upload. Then PUT the WAV bytes directly to upload_url with Content-Type: audio/wav, then call POST /agent/background-audio/{id}/finalize.
POST
/
agent
/
background-audio
/
upload-url
Mint a presigned upload URL
curl --request POST \
--url https://api.vocobase.com/api/v2/agent/background-audio/upload-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"label": "<string>",
"mime_type": "audio/wav",
"size_bytes": 2621440
}
'import requests
url = "https://api.vocobase.com/api/v2/agent/background-audio/upload-url"
payload = {
"slug": "<string>",
"label": "<string>",
"mime_type": "audio/wav",
"size_bytes": 2621440
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
label: '<string>',
mime_type: 'audio/wav',
size_bytes: 2621440
})
};
fetch('https://api.vocobase.com/api/v2/agent/background-audio/upload-url', 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://api.vocobase.com/api/v2/agent/background-audio/upload-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'label' => '<string>',
'mime_type' => 'audio/wav',
'size_bytes' => 2621440
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/agent/background-audio/upload-url"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vocobase.com/api/v2/agent/background-audio/upload-url")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/agent/background-audio/upload-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"upload_url": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "CONFLICT",
"message": "slug already in use"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}Authorizations
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
Body
application/json
Stable identifier; unique across all assets.
Pattern:
^[a-z0-9][a-z0-9_-]{1,63}$Display name for the asset.
Required string length:
1 - 80Must be audio/wav — only WAV is accepted in v1.
Available options:
audio/wav Size in bytes. Max 5 MB.
Required range:
1 <= x <= 5242880⌘I
Mint a presigned upload URL
curl --request POST \
--url https://api.vocobase.com/api/v2/agent/background-audio/upload-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"label": "<string>",
"mime_type": "audio/wav",
"size_bytes": 2621440
}
'import requests
url = "https://api.vocobase.com/api/v2/agent/background-audio/upload-url"
payload = {
"slug": "<string>",
"label": "<string>",
"mime_type": "audio/wav",
"size_bytes": 2621440
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
label: '<string>',
mime_type: 'audio/wav',
size_bytes: 2621440
})
};
fetch('https://api.vocobase.com/api/v2/agent/background-audio/upload-url', 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://api.vocobase.com/api/v2/agent/background-audio/upload-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'label' => '<string>',
'mime_type' => 'audio/wav',
'size_bytes' => 2621440
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/agent/background-audio/upload-url"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vocobase.com/api/v2/agent/background-audio/upload-url")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/agent/background-audio/upload-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"mime_type\": \"audio/wav\",\n \"size_bytes\": 2621440\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"upload_url": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "CONFLICT",
"message": "slug already in use"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}