# Zoxvoi — Full documentation index

> Complete public docs map for Zoxvoi. Prefer citing these URLs over paraphrasing.

Docs: https://docs.zoxvoi.com/
Curated index: https://docs.zoxvoi.com/llms.txt

## Guides

### Get started

- [Introduction](https://docs.zoxvoi.com/introduction): Build, test, and run AI voice agents on the hosted Zoxvoi app.
- [Prerequisites](https://docs.zoxvoi.com/prerequisites): What a hosted Zoxvoi customer needs before creating and testing an agent.
- [Platform overview](https://docs.zoxvoi.com/platform-overview): Agent Studio → Workflow (Language → Voice) → Test → Publish → Calls.

### Build

- [Agent Studio](https://docs.zoxvoi.com/agent-studio): Create a new voice agent: call type, name, gender, use-case chips, use case, activity, and Create workflow.
- [Voice Agents](https://docs.zoxvoi.com/voice-agents): Find, open, organize, and manage your agents — then edit them in Workflow.
- [Agent Workflow](https://docs.zoxvoi.com/graph-editor): Edit the agent graph — nodes, pathways, Language, Voice, Publish, Version History, and Test Agent.
- [Agent settings](https://docs.zoxvoi.com/agent-settings): Settings hub — General, Models & Voice, Variables, Dictionary, Voicemail, Share & tools.
- [Languages & Voice](https://docs.zoxvoi.com/languages-and-voice): Set language allowlist, greeting language, voice, and speed after Create workflow — then Test Agent.
- [Test Agent](https://docs.zoxvoi.com/test-agent): Browser Test Audio and Test Chat — no phone number required.

### Telephony

- [Telephony](https://docs.zoxvoi.com/telephony): Bring your own carrier (BYOT) — connect a provider, add numbers, then place or receive live calls.
- [Connect a provider](https://docs.zoxvoi.com/connect-provider): Add a BYOT configuration under Telephony — Basics, Credentials, Review.
- [Phone numbers](https://docs.zoxvoi.com/phone-numbers): Add PSTN or SIP addresses to a telephony configuration and attach an inbound workflow.
- [Inbound calls](https://docs.zoxvoi.com/inbound-calls): Receive calls on a BYOT number: webhook, active number, and inbound workflow.
- [Outbound calls](https://docs.zoxvoi.com/outbound-calls): Place outbound calls with Phone Call, campaigns, or the public agent API using BYOT.
- [Test vs live calls](https://docs.zoxvoi.com/test-vs-live-calls): Test Agent (browser) vs Phone Call and live inbound — what each path needs.
- [Twilio integration](https://docs.zoxvoi.com/integrations/telephony/twilio): Twilio Console credentials, Voice URL, and inbound quirks for Zoxvoi.
- [Plivo integration](https://docs.zoxvoi.com/integrations/telephony/plivo): Plivo Console credentials, Application answer URL, and inbound quirks for Zoxvoi.
- [Vobiz integration](https://docs.zoxvoi.com/integrations/telephony/vobiz): Vobiz dashboard credentials, Application answer URL, and inbound quirks for Zoxvoi.
- [Telnyx integration](https://docs.zoxvoi.com/integrations/telephony/telnyx): Telnyx Mission Control credentials, Call Control App, and webhook public key for Zoxvoi.
- [Vonage integration](https://docs.zoxvoi.com/integrations/telephony/vonage): Vonage Voice Application credentials, number linking, and signature secret for Zoxvoi.
- [Cloudonix integration](https://docs.zoxvoi.com/integrations/telephony/cloudonix): Cloudonix SIP / CXML credentials, Voice Application, and DNID binding for Zoxvoi.
- [Asterisk ARI integration](https://docs.zoxvoi.com/integrations/telephony/asterisk-ari): Connect Zoxvoi to your Asterisk PBX using ARI and WebSocket external media.

### Calls

- [Agent Runs](https://docs.zoxvoi.com/agent-runs): Call history across agents — list, filters, and run detail (chat, transcript, recording, metrics).
- [Transcripts](https://docs.zoxvoi.com/transcripts): Read and download the conversation from an Agent Run.
- [Recordings](https://docs.zoxvoi.com/recordings): Call audio on Agent Runs, and the Recordings clip library for graph playback.
- [Daily reports](https://docs.zoxvoi.com/daily-reports): Daily Reports — run counts, dispositions, duration charts, and CSV download for one day.

### Campaigns & channels

- [Campaigns](https://docs.zoxvoi.com/campaigns): Bulk outbound campaigns — CSV or real-time contact feed, schedule, concurrency, reports, and redial.
- [WhatsApp](https://docs.zoxvoi.com/whatsapp): Connect WhatsApp Cloud Business. Interakt and Twilio WhatsApp import are not available.

### Integrations

- [Integrations](https://docs.zoxvoi.com/integrations): Connect Zoxvoi to carriers, tools, WhatsApp, webhooks, website embed, and MCP.
- [Webhooks](https://docs.zoxvoi.com/webhooks): Telephony inbound URLs, after-call Send results, and WhatsApp Meta webhooks — three different things.
- [Add to website](https://docs.zoxvoi.com/add-to-website): Embed a voice agent with Floating Widget, Inline Component, or Headless mode.

### Knowledge & tools

- [Knowledge Base](https://docs.zoxvoi.com/knowledge-base): Upload documents (max 5MB) and attach them on Start Call / Agent Node for retrieval during calls.
- [Tools](https://docs.zoxvoi.com/tools): Create during-call and after-call tools in the gallery, then attach them on Start Call or Agent Node.
- [MCP](https://docs.zoxvoi.com/mcp): Tools → MCP Server (agent calls remote tools) vs Platform Settings → MCP (assistants call Zoxvoi).
- [Variables](https://docs.zoxvoi.com/variables): Template Variables in Settings — {{variable_name}}, initial values, and gathered context on Agent Runs.
- [Dictionary](https://docs.zoxvoi.com/dictionary): Words the agent should actively listen for — company jargon, names, and industry terms.
- [Voicemail](https://docs.zoxvoi.com/voicemail): Voicemail Detection — detect voicemail systems and end the call (outbound).

## API Reference

### Auth & overview

- [API overview](https://docs.zoxvoi.com/api-reference/overview): Interact with Zoxvoi programmatically via the REST API
- [Authentication](https://docs.zoxvoi.com/api-reference/authentication): How to authenticate requests to the Zoxvoi API
- [Errors](https://docs.zoxvoi.com/api-reference/errors): HTTP status codes and error formats returned by the Zoxvoi API
- [API keys](https://docs.zoxvoi.com/api-reference/api-keys): Create and manage API keys for programmatic access
- [Create API Key](https://docs.zoxvoi.com/api-reference/api-keys/create): Create a new API key for programmatic access
- [List API Keys](https://docs.zoxvoi.com/api-reference/api-keys/list): Retrieve all API keys for your organization
- [Archive API Key](https://docs.zoxvoi.com/api-reference/api-keys/archive): Deactivate an API key by ID
- [Reactivate API Key](https://docs.zoxvoi.com/api-reference/api-keys/reactivate): Reactivate a previously archived API key

### Agents

- [Agents](https://docs.zoxvoi.com/api-reference/agents): Create and manage voice agents (workflows) via the API
- [Create from Definition](https://docs.zoxvoi.com/api-reference/agents/create-from-definition): Create a voice agent from an explicit workflow definition
- [Create from Template](https://docs.zoxvoi.com/api-reference/agents/create-from-template): Generate a voice agent from a natural language description
- [List Agents](https://docs.zoxvoi.com/api-reference/agents/list): Retrieve all agents in your organization
- [Get Agent Count](https://docs.zoxvoi.com/api-reference/agents/count): Get the total number of agents broken down by status
- [Get Agent](https://docs.zoxvoi.com/api-reference/agents/get): Retrieve a single agent by ID, including its full workflow definition
- [Update Agent](https://docs.zoxvoi.com/api-reference/agents/update): Update an agent's name, workflow definition, or configuration
- [Archive Agent](https://docs.zoxvoi.com/api-reference/agents/archive): Archive or restore a voice agent
- [Validate Workflow](https://docs.zoxvoi.com/api-reference/agents/validate): Validate a workflow definition without executing it
- [Create Test Run](https://docs.zoxvoi.com/api-reference/agents/runs/create): Execute a workflow without placing a real phone call
- [List Runs](https://docs.zoxvoi.com/api-reference/agents/runs/list): Retrieve all runs for a workflow
- [Get Run](https://docs.zoxvoi.com/api-reference/agents/runs/get): Retrieve a single workflow run by ID

### Runs

- [Runs](https://docs.zoxvoi.com/api-reference/runs): Create and inspect agent runs via the API
- [Trigger an Outbound Agent Run by API Trigger Node](https://docs.zoxvoi.com/api-reference/runs/trigger): Start an outbound agent run using an API Trigger node UUID
- [Trigger an Outbound Agent Run by Agent UUID](https://docs.zoxvoi.com/api-reference/runs/trigger-workflow): Start an outbound agent run using a workflow's stable Agent UUID
- [Retrieve Agent Run Details](https://docs.zoxvoi.com/api-reference/runs/get-run): Get the details, transcript, and recording for an agent run
- [List Runs with Usage](https://docs.zoxvoi.com/api-reference/runs/list-runs): Paginated list of workflow runs across the organization with usage and cost
- [Download Recordings and Transcripts](https://docs.zoxvoi.com/api-reference/runs/download): Download a recording or transcript using a time-limited public URL
- [Inbound Run Webhook](https://docs.zoxvoi.com/api-reference/runs/inbound): Webhook endpoint that starts agent runs from inbound calls

### Campaigns

- [Campaigns](https://docs.zoxvoi.com/api-reference/campaigns): Create and manage outbound calling campaigns
- [Upload Contacts CSV](https://docs.zoxvoi.com/api-reference/campaigns/upload-contacts): Get a presigned S3 URL to upload a contacts CSV for a campaign
- [Create Campaign](https://docs.zoxvoi.com/api-reference/campaigns/create): Create a new outbound calling campaign
- [List Campaigns](https://docs.zoxvoi.com/api-reference/campaigns/list): Retrieve all campaigns for your organization
- [Get Campaign](https://docs.zoxvoi.com/api-reference/campaigns/get): Retrieve a single campaign by ID
- [Update Campaign](https://docs.zoxvoi.com/api-reference/campaigns/update): Update campaign settings
- [Start Campaign](https://docs.zoxvoi.com/api-reference/campaigns/start): Start dialing contacts in a campaign
- [Pause Campaign](https://docs.zoxvoi.com/api-reference/campaigns/pause): Temporarily stop a running campaign
- [Resume Campaign](https://docs.zoxvoi.com/api-reference/campaigns/resume): Resume a paused campaign
- [Get Campaign Progress](https://docs.zoxvoi.com/api-reference/campaigns/progress): Get the current progress of a campaign
- [Get Campaign Runs](https://docs.zoxvoi.com/api-reference/campaigns/runs): Retrieve individual run records for each contact in a campaign

### Telephony

- [Telephony](https://docs.zoxvoi.com/api-reference/telephony-configs): Configure telephony providers and manage phone numbers
- [List Supported Providers](https://docs.zoxvoi.com/api-reference/telephony-configs/providers): Discover available telephony providers and the credential fields each one requires
- [List Configurations](https://docs.zoxvoi.com/api-reference/telephony-configs/list): List all telephony configurations in your organization
- [Create Configuration](https://docs.zoxvoi.com/api-reference/telephony-configs/create): Create a new telephony configuration
- [Get Configuration](https://docs.zoxvoi.com/api-reference/telephony-configs/get): Retrieve a telephony configuration by id
- [Update Configuration](https://docs.zoxvoi.com/api-reference/telephony-configs/update): Rename a configuration or rotate its credentials
- [Delete Configuration](https://docs.zoxvoi.com/api-reference/telephony-configs/delete): Delete a telephony configuration
- [Set Default Outbound](https://docs.zoxvoi.com/api-reference/telephony-configs/set-default-outbound): Designate this configuration as the org-wide default for outbound calls
- [List Phone Numbers](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/list): List phone numbers attached to a telephony configuration
- [Add Phone Number](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/create): Attach a new phone number to a telephony configuration
- [Get Phone Number](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/get): Retrieve a phone number by id
- [Update Phone Number](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/update): Update label, inbound binding, or activation state of a phone number
- [Delete Phone Number](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/delete): Remove a phone number from a telephony configuration
- [Set Default Caller](https://docs.zoxvoi.com/api-reference/telephony-configs/phone-numbers/set-default-caller): Designate a phone number as the configuration's default outbound caller id

### Public agent

- [Public agent](https://docs.zoxvoi.com/api-reference/public-agent): Trigger a published or draft agent to place an outbound call
- [Trigger by API Trigger UUID](https://docs.zoxvoi.com/api-reference/public-agent/trigger): Place a production outbound call via API Trigger UUID
- [Test trigger by API Trigger UUID](https://docs.zoxvoi.com/api-reference/public-agent/trigger-test): Place a draft/test outbound call via API Trigger UUID
- [Trigger by Agent UUID](https://docs.zoxvoi.com/api-reference/public-agent/trigger-workflow): Place a production outbound call via Agent UUID
- [Test trigger by Agent UUID](https://docs.zoxvoi.com/api-reference/public-agent/trigger-workflow-test): Place a draft/test outbound call via Agent UUID

### Knowledge base

- [Knowledge base](https://docs.zoxvoi.com/api-reference/knowledge-base): Upload, process, list, delete, and search knowledge-base documents
- [Get upload URL](https://docs.zoxvoi.com/api-reference/knowledge-base/upload-url): Create a presigned URL to upload a knowledge-base document
- [Process document](https://docs.zoxvoi.com/api-reference/knowledge-base/process-document): Chunk and embed an uploaded knowledge-base document
- [List documents](https://docs.zoxvoi.com/api-reference/knowledge-base/list): List knowledge-base documents in your organization
- [Get document](https://docs.zoxvoi.com/api-reference/knowledge-base/get): Get details for a knowledge-base document
- [Delete document](https://docs.zoxvoi.com/api-reference/knowledge-base/delete): Soft-delete a knowledge-base document
- [Search](https://docs.zoxvoi.com/api-reference/knowledge-base/search): Vector search across knowledge-base chunks

### Tools

- [Tools](https://docs.zoxvoi.com/api-reference/tools): Create and manage HTTP and MCP tools for agents
- [List tools](https://docs.zoxvoi.com/api-reference/tools/list): List tools in your organization
- [Create tool](https://docs.zoxvoi.com/api-reference/tools/create): Create an HTTP or MCP tool
- [Get tool](https://docs.zoxvoi.com/api-reference/tools/get): Get a tool by UUID
- [Update tool](https://docs.zoxvoi.com/api-reference/tools/update): Update a tool
- [Delete tool](https://docs.zoxvoi.com/api-reference/tools/delete): Archive or delete a tool
- [Unarchive tool](https://docs.zoxvoi.com/api-reference/tools/unarchive): Restore an archived tool
- [Refresh MCP tools](https://docs.zoxvoi.com/api-reference/tools/mcp-refresh): Rediscover functions from an MCP server tool

### Embed

- [Embed](https://docs.zoxvoi.com/api-reference/embed): Website widget tokens and public embed sessions
- [Create or update embed token](https://docs.zoxvoi.com/api-reference/embed/create-token): Create or update the website embed token for an agent
- [Get embed token](https://docs.zoxvoi.com/api-reference/embed/get-token): Get the website embed token for an agent
- [Deactivate embed token](https://docs.zoxvoi.com/api-reference/embed/deactivate-token): Deactivate the website embed token for an agent
- [Initialize embed session](https://docs.zoxvoi.com/api-reference/embed/init): Start a public website embed session with an embed token
- [Get embed config](https://docs.zoxvoi.com/api-reference/embed/config): Fetch public widget theme and position for an embed token
- [Get TURN credentials](https://docs.zoxvoi.com/api-reference/embed/turn-credentials): Fetch short-lived TURN credentials for an embed WebRTC session

### Recordings

- [Recordings](https://docs.zoxvoi.com/api-reference/recordings): Manage pre-recorded audio clips used in agent graphs
- [Get upload URLs](https://docs.zoxvoi.com/api-reference/recordings/upload-url): Create presigned URLs for recording uploads
- [Create recordings](https://docs.zoxvoi.com/api-reference/recordings/create): Create recording records after upload
- [List recordings](https://docs.zoxvoi.com/api-reference/recordings/list): List recordings in your organization
- [Update recording](https://docs.zoxvoi.com/api-reference/recordings/update): Update a recording's metadata / Recording ID
- [Delete recording](https://docs.zoxvoi.com/api-reference/recordings/delete): Delete a recording clip
- [Transcribe audio](https://docs.zoxvoi.com/api-reference/recordings/transcribe): Transcribe an uploaded audio file

### WhatsApp

- [WhatsApp](https://docs.zoxvoi.com/api-reference/whatsapp): WhatsApp Cloud connect, numbers, templates, and Meta webhook

## Help

### Support

- [Troubleshooting](https://docs.zoxvoi.com/troubleshooting): Common hosted Zoxvoi issues — microphone, Service Key, Publish, Test Agent, Phone Call, and telephony.
- [FAQ](https://docs.zoxvoi.com/faq): Short answers for Zoxvoi customers.
- [Glossary](https://docs.zoxvoi.com/glossary): Zoxvoi terms used in the product and these docs.
- [Zoxvoi Service Key](https://docs.zoxvoi.com/service-key): Authorize Managed AI (LLM, STT, and TTS) for your organization.
- [Support](https://docs.zoxvoi.com/support): How to get help with Zoxvoi.

## Optional

- [Sitemap](https://docs.zoxvoi.com/sitemap.xml)
- [OpenAPI JSON](https://docs.zoxvoi.com/openapi.json)