Αναφορά API / Account
Account
Τα endpoints της ομάδας Account του Voiceland AI API, με παραμέτρους, σχήματα και παραδείγματα curl.
Τελευταία ενημέρωση:
Οι περιγραφές των endpoints και των πεδίων εμφανίζονται στα αγγλικά, όπως ακριβώς τις δημοσιεύει το API. Είναι επιλογή μας, ώστε να διαβάζετε εδώ ό,τι θα δείτε και στις αποκρίσεις.
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).
Σώμα αιτήματος
application/json Σχήμα: SessionLocalRequest
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
agent |
string | Ναι | Agent to open a local session for. |
scopes |
array of string |
Αποκρίσεις
| Κωδικός | Περιγραφή |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Παράδειγμα αιτήματος
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"
}'
Η επιτυχής απόκριση επιστρέφει ένα SessionLocalResponse.
Παράδειγμα απόκρισης
{
"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.
Αποκρίσεις
| Κωδικός | Περιγραφή |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Παράδειγμα αιτήματος
curl "https://api.voiceland.ai/v1/tenant" \
-H "Authorization: Bearer VL_API_KEY"
Η επιτυχής απόκριση επιστρέφει ένα Response.
Παράδειγμα απόκρισης
{
"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).
Αποκρίσεις
| Κωδικός | Περιγραφή |
|---|---|
200 |
Success. |
401 |
Missing or invalid API key. |
4XX |
Request error (validation, not-found, etc.). |
5XX |
Server or upstream error. |
Παράδειγμα αιτήματος
curl "https://api.voiceland.ai/v1/voices" \
-H "Authorization: Bearer VL_API_KEY"
Παράδειγμα απόκρισης
{
"items": [
{
"display_name": "Adam",
"languages": [
"en"
],
"provider": "elevenlabs",
"voice_id": "pNInz6obpgDQGcFmaJgB"
}
]
}
Σχήματα#
Error#
Error envelope returned for non-2xx responses.
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
error |
object | Ναι |
OutboundView#
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
host |
string | ||
port |
integer | ||
ready |
boolean | Ναι | |
transport |
string |
Response#
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
default_api_version |
string | Ναι | |
outbound |
OutboundView |
||
sip_trunk |
string | Ναι | Your inbound SIP trunk URI. |
slug |
string | Ναι | Your tenant slug. |
SessionLocalRequest#
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
agent |
string | Ναι | Agent to open a local session for. |
scopes |
array of string |
SessionLocalResponse#
| Πεδίο | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
api_version |
string | Ναι | |
broker_ws_urls |
map of string | Ναι | |
expires_at |
string | Ναι | |
token |
string | Ναι |