Référence de l'API / Account

Account

Les endpoints du groupe Account de l'API Voiceland AI, avec les paramètres, les schémas et des exemples curl.

Dernière mise à jour:

Les descriptions des endpoints et des champs restent en anglais, telles que l'API les publie. C'est un choix délibéré : vous lisez ici ce que vous verrez aussi dans les réponses.

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).

Corps de la requête

application/json Schéma : SessionLocalRequest

Champ Type Requis Description
agent string Oui Agent to open a local session for.
scopes array of string

Réponses

Code Description
200 Success.
401 Missing or invalid API key.
4XX Request error (validation, not-found, etc.).
5XX Server or upstream error.

Exemple de requête

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"
}'

Une réponse réussie renvoie un SessionLocalResponse.

Exemple de réponse

{
  "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.

Réponses

Code Description
200 Success.
401 Missing or invalid API key.
4XX Request error (validation, not-found, etc.).
5XX Server or upstream error.

Exemple de requête

curl "https://api.voiceland.ai/v1/tenant" \
  -H "Authorization: Bearer VL_API_KEY"

Une réponse réussie renvoie un Response.

Exemple de réponse

{
  "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).

Réponses

Code Description
200 Success.
401 Missing or invalid API key.
4XX Request error (validation, not-found, etc.).
5XX Server or upstream error.

Exemple de requête

curl "https://api.voiceland.ai/v1/voices" \
  -H "Authorization: Bearer VL_API_KEY"

Exemple de réponse

{
  "items": [
    {
      "display_name": "Adam",
      "languages": [
        "en"
      ],
      "provider": "elevenlabs",
      "voice_id": "pNInz6obpgDQGcFmaJgB"
    }
  ]
}

Schémas#

Error#

Error envelope returned for non-2xx responses.

Champ Type Requis Description
error object Oui

OutboundView#

Champ Type Requis Description
host string
port integer
ready boolean Oui
transport string

Response#

Champ Type Requis Description
default_api_version string Oui
outbound OutboundView
sip_trunk string Oui Your inbound SIP trunk URI.
slug string Oui Your tenant slug.

SessionLocalRequest#

Champ Type Requis Description
agent string Oui Agent to open a local session for.
scopes array of string

SessionLocalResponse#

Champ Type Requis Description
api_version string Oui
broker_ws_urls map of string Oui
expires_at string Oui
token string Oui

La console

Ces pages sont en lecture seule. L'appel de test, les clés API et la référence de l'API à jour se trouvent dans la console, où votre compte est connecté.

Ouvrir la console