Справочник API / Account

Account

Endpoints группы Account в API Voiceland AI, с параметрами, схемами и примерами 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 Да

Консоль

Эти страницы доступны только для чтения. Тестовый звонок, ключи API и актуальный справочник API находятся в консоли, где выполнен вход в ваш аккаунт.

Открыть консоль