# Botnoi Voice API

> Machine-readable index of the Botnoi Voice public developer documentation. Each linked page is also available as Markdown by appending ".md" to its URL.

## Getting started
- [Getting started](https://voicebot.botnoigroup.com/docs/getting-started): Go from an access token to your first call's transcript in 6 steps, with a copy-paste request for each.

## Account
- [Get your account](https://voicebot.botnoigroup.com/docs/get-me): Who you are signed in as. Its `_id` is your setup ID — the value every Telephony setup and call request takes as `tenant_id`.

## Agents
- [Create or update an agent](https://voicebot.botnoigroup.com/docs/put-agent-create_update_agent): Creates the agent when it does not exist yet, and updates it when it does. This is the recommended way to write agent configuration.
- [List your agents](https://voicebot.botnoigroup.com/docs/get-agents): Every voice agent on your account.
- [Get an agent](https://voicebot.botnoigroup.com/docs/get-agents-agent_id): The full stored configuration for a single agent.
- [Delete an agent](https://voicebot.botnoigroup.com/docs/delete-agent-delete-agent_id): Remove an agent from your account.

## Catalog
- [List speech-to-text providers](https://voicebot.botnoigroup.com/docs/get-info-asr_providers): The speech recognition providers you can assign to an agent.
- [List text-to-speech providers](https://voicebot.botnoigroup.com/docs/get-info-get_tts_providers): The voice synthesis providers you can assign to an agent.

## Telephony setup
- [Create your Telephony setup](https://voicebot.botnoigroup.com/docs/put-v1-provisioning-tenants-tenant_id): Connect your PBX as a trunk and create your Telephony setup. `tenant_id` is your setup ID — the `_id` from Get your account.
- [Get trunk status](https://voicebot.botnoigroup.com/docs/get-v1-provisioning-tenants-tenant_id-trunk-status): The current state of your trunk.
- [Get your setup overview](https://voicebot.botnoigroup.com/docs/get-v1-provisioning-tenants-tenant_id-overview): Your Telephony setup in one read, narrowed with `include` and `month`.
- [Assign a number](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-dids-assign): Add a phone number (DID) to your Telephony setup, optionally bound to an agent.
- [Bind a number to an agent](https://voicebot.botnoigroup.com/docs/put-v1-provisioning-tenants-tenant_id-dids-did): Choose which agent answers calls to one of your phone numbers.
- [Refresh the transfer allowlist](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-transfer-allowlist): Rebuild the numbers your agents may transfer calls to, from the agents bound to your phone numbers.
- [Update your Telephony setup](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-update): Change your Telephony setup. An update replaces the whole config: an optional block you leave out is cleared. Read the current config from `sections.tenant.data` in Get your setup overview, keep only the fields listed below, change what you need, and send the whole config back here. Leave out `pbx.auth.password` to keep the stored trunk password.
- [Resync numbers](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-dids-resync): Re-apply routing for your phone numbers.
- [Pause telephony](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-disable): Stop your Telephony setup from answering and placing calls. Resume telephony brings service back.
- [Resume telephony](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-enable): Bring a paused Telephony setup back into service.
- [Detach a number](https://voicebot.botnoigroup.com/docs/delete-v1-provisioning-tenants-tenant_id-dids-did): Remove a phone number from your Telephony setup.
- [Delete telephony setup](https://voicebot.botnoigroup.com/docs/delete-v1-provisioning-tenants-tenant_id): Remove your Telephony setup for good. Refused while it still holds a phone number — detach each one first.

## Outbound
- [Place a call through your trunk](https://voicebot.botnoigroup.com/docs/post-v1-provisioning-tenants-tenant_id-calls): Dial `destination` with one of your agents over your trunk. `tenant_id` is your setup ID — the `_id` from Get your account.
- [Get a call's status](https://voicebot.botnoigroup.com/docs/get-v1-provisioning-tenants-tenant_id-calls-call_id): Poll the status of a call placed through your trunk.

## Conversation Logs
- [List conversation files](https://voicebot.botnoigroup.com/docs/get-logs-list_file): The stored conversation files for one agent, optionally narrowed with `start_date` and `end_date`. Keep the trailing slash on this path.
- [Read a conversation transcript](https://voicebot.botnoigroup.com/docs/get-logs-read_log): One conversation's transcript, addressed by a `file_path` from List conversation files. Keep the trailing slash on this path.
- [Get a recording link](https://voicebot.botnoigroup.com/docs/get-logs-audio_url): Returns a JSON link to a call recording rather than the audio itself.
- [Export conversations as CSV](https://voicebot.botnoigroup.com/docs/post-logs-log-export): Builds a CSV export of conversation history.
- [Export conversations as PDF](https://voicebot.botnoigroup.com/docs/post-logs-log-export-pdf): Builds a PDF export of conversation history.

## Dashboard
- [Get dashboard overview](https://voicebot.botnoigroup.com/docs/get-dashboard-v1-overview): Call metrics between `start_at` and `end_at`, grouped by `granularity` and optionally narrowed with `agent_id` and `source`.

## Tools
- [Create a tool](https://voicebot.botnoigroup.com/docs/post-platform-config-tools): Define a custom tool an agent can call mid-conversation.
- [List tools](https://voicebot.botnoigroup.com/docs/get-platform-config-tools): The custom tools your agents can call during a conversation.
- [Update a tool](https://voicebot.botnoigroup.com/docs/put-platform-config-tools-tool_id): Change a custom tool's definition.
- [Delete a tool](https://voicebot.botnoigroup.com/docs/delete-platform-config-tools-tool_id): Remove a custom tool.

## Preview Call
- [Realtime](https://voicebot.botnoigroup.com/docs/preview-call): Mint a call token with your access token, open the WebSocket with it, stream microphone audio in and receive transcripts and TTS back.
- [Create a call token](https://voicebot.botnoigroup.com/docs/post-call-tokens): Step one of a preview call: mint a single-use call token for one of your agents from your server, then open Realtime's WebSocket with it.
- [Save a preview call log](https://voicebot.botnoigroup.com/docs/post-call_logs_platform): Save the log a browser preview call leaves when it ends — never a phone call's log; those are Conversation Logs.
- [List preview call logs](https://voicebot.botnoigroup.com/docs/get-logs-call_logs_platform): The logs saved by browser preview calls with one agent — never a phone call's log; those are Conversation Logs. `agent_id` is required; `limit` caps how many come back.
- [Get a preview call log](https://voicebot.botnoigroup.com/docs/get-logs-call_logs_platform-conversation_id): The log one browser preview call saved — never a phone call's log; those are Conversation Logs.