API Docs
Voxbi Cockpit APIs
All endpoints

Get a sound File

Returns the sound file identified by the path parameter. Multi-tenant scoping is enforced: the caller can only fetch resources within their own PBX.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
HTTP: IntegrationApiKey

API key created on the Cockpit Integrations page (an "API key" integration). It is a bearer token owned by the customer's PBX and limited to the scopes selected when the key was created (e.g. phone-numbers, push-configuration).

Send it in the Authorization header:

Authorization: Bearer <api_key>

Manage keys (create / reveal / revoke) from Integrations → New integration → API key.

HTTP Authorization Scheme
bearer
id path · string · uuid *
accept header · string
example: application/json

Responses

Response schema
id*string · uuid
Sound file identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_idstring | null · uuid
Pbx identifier (null for built-in/protected files)
example: 550e8400-e29b-41d4-a716-446655440001
parent_idstring | null · uuid
Identifier of the default/fallback announcement this record is a language variant of. `null` for a top-level announcement. The list is flat and includes variants: switch to a variant whose `language` matches the caller's detected language, otherwise play the parent as the fallback.
example: 550e8400-e29b-41d4-a716-446655440002
name*string
length: 0–64
example: Welcome announcement
commentstring | null
length: 0–255
example: Played at the start of the main IVR
messagestring | null
TTS source text (only populated when `source = ai_generated`)
example: Welcome to Customer Support. Press 1 for sales, 2 for support.
ai_voice_idstring | null
Identifier of the AI voice used to generate the audio
example: voice_en_us_female_1
voice_settingsobject | null
AI voice tuning settings (pitch, speed, etc.) as a JSON object
example: {"stability":0.75,"similarity_boost":0.5}
source*string
Whether the audio was uploaded by the user or AI-generated
enum: ai_generated uploaded_file
example: uploaded_file
type*string
Intended use category for the sound
enum: announcement music
example: announcement
languagestring | null
ISO-639-1 language of this announcement. Set on parents that have variants and on every variant; may be `null` on a plain standalone announcement. Used by the PBX to match a variant to the caller's detected language.
enum: en de fr lb es it pt nl pl ru tr sv da no fi cs sk el hu ro bg hr uk ar he hi ja ko zh id ms th vi null
example: en
audio_urlstring · uri
Short-lived signed URL to a streaming endpoint for the audio. Plays directly in an <audio src> with no auth header and expires after a short window. The raw audio payload is never inlined in this response.
read-only
example: https://api.example.com/sound-files/550e8400-e29b-41d4-a716-446655440000/audio?signature=abc123&expires=1709280000
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/sound-files/{soundFile}
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/sound-files/{soundFile}' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/sound-files/{soundFile}', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/sound-files/{soundFile}',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/sound-files/{soundFile}', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}