API Docs
Voxbi Cockpit APIs
All endpoints

Get AI configuration (pbx)

Returns the PBX's aggregated, read-only AI configuration: the account-wide global prompt and labels, the classification keyword tree, per-extension and per-group prompts, and the active AI profile and feature flags.

Requires a PBX "API key" carrying the ai-configuration scope. The PBX is resolved from the token.

HTTP: PbxApiKey

PBX API key, used by the customer's PBX server (e.g. for roaming login/logout)

HTTP Authorization Scheme
bearer
Bearer format
Bearer <pbx_api_key>
accept header · string
example: application/json

Responses

Response schema
pbx_id*string · uuid
PBX identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440000
ai_profilestring | null
Active AI plan for the PBX (null when the PBX is not on an AI plan)
enum: unlimited basic premium null
example: premium
ai_features*object
Enabled AI feature flags for the PBX
summaryboolean
example: 1
transcriptionboolean
example: 1
translationsboolean
example:
keyword_mapping_to_callboolean
example:
tagging_callsboolean
example:
sentiment_analysisboolean
example:
global_promptstring | null
Account-wide prompt every AI tool reads as ground truth
example: You are the AI assistant for Example Corp. Be concise and polite.
labelsarray<string>
Reusable classification labels, in display order
[]string
keywordsarray<object>
Hierarchical classification keywords. Each node carries an optional rule `prompt` and a `children` array of the same shape (recursively nested).
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440010
namestring
example: Billing
promptstring | null
The rule that tells the classifier when to apply this keyword
example: Apply when the caller asks about invoices or payments.
childrenarray<object>
Nested child keywords, each of the same shape
[]object
Free-form object
extension_promptsarray<object>
Per-extension AI prompts
extension_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440020
extensionstring | null
The extension number the prompt is attached to
example: 101
promptstring
example: Greet callers as the reception desk and offer to take a message.
group_promptsarray<object>
Per-group AI prompts
group_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440030
groupstring | null
The group name the prompt is attached to
example: Support
promptstring
example: Prioritise urgent tickets and confirm the caller's contract number.
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
The API key does not carry the `ai-configuration` scope.
Response schema
No response body.
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/ai-configuration
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/ai-configuration' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/ai-configuration', {
  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/ai-configuration',
    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/ai-configuration', 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
No example for this status.
{ … }
"message": "Server Error"
}