API-Referenz / Account
Account
Die Endpoints der Gruppe Account der Voiceland AI API, mit Parametern, Schemata und Beispielen mit curl.
Zuletzt aktualisiert:
Die Beschreibungen der Endpoints und der Felder erscheinen auf Englisch, genau so, wie die API sie ausliefert. Das ist Absicht: Sie lesen hier, was Sie auch in den Antworten sehen.
POST /v1/sessions/local#
Mint a local session. Mints a short-lived session token + broker WebSocket URLs for driving an agent locally (used by the SDK's local mode).
Anfragetext
application/json Schema: SessionLocalRequest
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
agent |
string | Ja | Agent to open a local session for. |
scopes |
array of string |
Antworten
| Code | Beschreibung |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Beispielanfrage
curl -X POST "https://api.voiceland.ai/v1/sessions/local" \
-H "Authorization: Bearer VL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agent": "front-desk"
}'
Eine erfolgreiche Antwort liefert ein SessionLocalResponse.
Beispielantwort
{
"api_version": "2026-04-26",
"token": "…"
}
GET /v1/tenant#
Get your tenant profile. Your tenant slug, default API version, inbound SIP trunk, and (when configured) the outbound trunk state.
Antworten
| Code | Beschreibung |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Beispielanfrage
curl "https://api.voiceland.ai/v1/tenant" \
-H "Authorization: Bearer VL_API_KEY"
Eine erfolgreiche Antwort liefert ein Response.
Beispielantwort
{
"default_api_version": "2026-04-26",
"slug": "acme"
}
GET /v1/voices#
List voices. The catalog of available voices you can set on an agent (use voice_id in voice.voice_id).
Antworten
| Code | Beschreibung |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Beispielanfrage
curl "https://api.voiceland.ai/v1/voices" \
-H "Authorization: Bearer VL_API_KEY"
Beispielantwort
{
"items": [
{
"display_name": "Adam",
"languages": [
"en"
],
"provider": "elevenlabs",
"voice_id": "pNInz6obpgDQGcFmaJgB"
}
]
}
Schemata#
Error#
Error envelope returned for non-2xx responses.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
error |
object | Ja |
OutboundView#
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host |
string | ||
port |
integer | ||
ready |
boolean | Ja | |
transport |
string |
Response#
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
default_api_version |
string | Ja | |
outbound |
OutboundView |
||
sip_trunk |
string | Ja | Your inbound SIP trunk URI. |
slug |
string | Ja | Your tenant slug. |
SessionLocalRequest#
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
agent |
string | Ja | Agent to open a local session for. |
scopes |
array of string |
SessionLocalResponse#
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
api_version |
string | Ja | |
broker_ws_urls |
map of string | Ja | |
expires_at |
string | Ja | |
token |
string | Ja |