Справочник API
Справочник API
Все endpoints API Voiceland AI: аутентификация, базовый адрес, версия API и примеры curl для каждой группы.
Описания endpoints и полей показаны на английском языке, ровно так, как их публикует API. Это наш выбор: здесь вы читаете то же, что увидите в ответах.
REST API for building and operating voice agents. Authenticate every request with your API key: Authorization: Bearer vsk_…. Optionally pin the dated API version with the Voiceland-Version header.
Аутентификация#
Каждый запрос передаёт ваш ключ API в заголовке Authorization, в формате Bearer. Ключи создаются в разделе Developers в консоли. Открыть консоль
Authorization: Bearer VL_API_KEYБазовый адрес#
Запросы отправляются на адрес:
https://api.voiceland.ai/v1Версия API#
При необходимости зафиксируйте датированную версию API, отправив заголовок:
Voiceland-Version: 2026-04-26Группы endpoints#
AI utilities
2 endpoints: Ask a question over a transcript, Transcribe audio.
Account
3 endpoints: Mint a local session, Get your tenant profile, List voices.
Agent assist
2 endpoints: Draft a reply for any conversation, Draft a reply for a live session.
Agent testing
7 endpoints: List test runs, Run a test scenario (synchronous), Get a test run и другие.
Agents
11 endpoints: List agents, Create or update an agent, Generate an agent from a brief и другие.
Audit
2 endpoints: List audit events, Get an audit event.
Calendar
17 endpoints: List bookings (by member window or by phone), Book an appointment, Get a booking и другие.
Calls
15 endpoints: List calls, Place an outbound call, Get a call и другие.
Chat takeover
11 endpoints: List representative availability, Set a representative's availability, List chat takeover sessions и другие.
Contacts
9 endpoints: List or look up contacts, Create a contact, Recent journalled calls и другие.
Data sources
8 endpoints: List connectors, List data sources, Create a data source и другие.
Demo tools
3 endpoints: Demo: a customer's bookings, Demo: look up an order, Demo: current weather for a city.
Evaluation
11 endpoints: List eval runs, Run the agent's golden set (pre-deploy eval), Get an eval run и другие.
Feedback
8 endpoints: List answer feedback, Rate an answer, Answer satisfaction analytics и другие.
Integrations
34 endpoints: Supported integrations as seen from an agent, Remove an integration, Enable or configure an integration и другие.
Intents
5 endpoints: List intent candidates, Promote an intent candidate, Dismiss an intent candidate и другие.
Knowledge base
39 endpoints: List collections, Create a collection, Delete a collection и другие.
Numbers
5 endpoints: Claim a number, List available numbers, Register an external number и другие.
Omnichannel
13 endpoints: List channel kinds, List channels, Delete a channel и другие.
Operations agents
33 endpoints: List operations agents, Create an operations agent, Design a board with AI и другие.
Self-service
31 endpoints: Per-agent call stats, List AI operations reports, AI operations report settings и другие.
Web widget
3 endpoints: List test links, Create a test link, Revoke a test link.