# PolyAI Platform

> PolyAI Platform documentation. Build, deploy, and monitor enterprise voice and chat agents ready for real customer conversations.

## Docs

- [PolyAI documentation](https://polyai-mintlify-7055a538.mintlify.site/home.md): Build agents ready for real customer conversations.
- [Platform overview](https://polyai-mintlify-7055a538.mintlify.site/platform/introduction.md): PolyAI's Agentic Dialog Platform is an enterprise platform for building voice and chat agents.
- [Agent Studio](https://polyai-mintlify-7055a538.mintlify.site/get-started/introduction.md): Visual interface for building, deploying, and monitoring PolyAI voice agents.
- [Quickstart](https://polyai-mintlify-7055a538.mintlify.site/get-started/quickstart.md): Create an account, build your first agent, and deploy it in minutes.
- [Meet the new Agent Studio](https://polyai-mintlify-7055a538.mintlify.site/get-started/whats-new.md): Agent Studio got a new layout on 24 June 2026. Watch the tour, see what moved, and find your favorite features in their new homes.
- [Wren](https://polyai-mintlify-7055a538.mintlify.site/wren/introduction.md): Build, test, debug, and analyze your agent in natural language, from anywhere in Agent Studio.
- [A full session, step by step](https://polyai-mintlify-7055a538.mintlify.site/wren/walkthrough.md): One build from first prompt to merged branch, with screenshots from a real session.
- [What Wren can build](https://polyai-mintlify-7055a538.mintlify.site/wren/building.md): Every part of your agent Wren can create and change, and the guardrails around each one.
- [Analyze conversations](https://polyai-mintlify-7055a538.mintlify.site/wren/analyze.md): Ask Wren natural-language questions about your agent's conversations and get answers backed by real transcripts.
- [Automated call review](https://polyai-mintlify-7055a538.mintlify.site/wren/automated-review.md): Let Wren read a stretch of recent calls on its own, find what's going wrong, and draft the fixes.
- [Chats and context](https://polyai-mintlify-7055a538.mintlify.site/wren/chats.md): History, attachments, voice input, web search, and the project context Wren carries into every conversation.
- [Prompting guide](https://polyai-mintlify-7055a538.mintlify.site/wren/prompting.md): Practical patterns for getting consistently good results from Wren, with real prompt examples for building, testing, asking, and analyzing.
- [Wren API](https://polyai-mintlify-7055a538.mintlify.site/wren/api.md): Drive Wren from your own code with a streaming HTTP endpoint.
- [Usage and limits](https://polyai-mintlify-7055a538.mintlify.site/wren/usage-and-limits.md): How Wren usage is tracked and what to do when you hit your limit.
- [Self-serve dashboards](https://polyai-mintlify-7055a538.mintlify.site/analytics/dashboards/introduction.md): Build and customise your own dashboards on the Analytics page.
- [Custom metrics](https://polyai-mintlify-7055a538.mintlify.site/analytics/kpis/introduction.md): Define and manage custom metrics for your agent.
- [PolyScore](https://polyai-mintlify-7055a538.mintlify.site/analytics/polyscore.md): An automated 1–5 conversation quality score for voice, messaging, and email.
- [CSAT surveys](https://polyai-mintlify-7055a538.mintlify.site/analytics/csat/introduction.md): Measure customer satisfaction with in-call voice CSAT surveys and webchat CSAT surveys.
- [Managed dashboards](https://polyai-mintlify-7055a538.mintlify.site/analytics/dashboards/custom.md): Dashboards that PolyAI builds and maintains for your organisation.
- [Conversations](https://polyai-mintlify-7055a538.mintlify.site/analytics/conversations/introduction.md): Inspect individual conversations to debug agent behavior and audit call quality.
- [Review](https://polyai-mintlify-7055a538.mintlify.site/analytics/conversations/review.md): Browse, filter, and inspect voice and webchat conversations from a single workspace.
- [Views](https://polyai-mintlify-7055a538.mintlify.site/analytics/conversations/views.md): Save filter and column combinations as private pinned tabs to make conversation review repeatable.
- [Annotations](https://polyai-mintlify-7055a538.mintlify.site/analytics/conversations/annotations.md): Flag good and bad agent responses, mark factual errors, and capture transcript and Knowledge gaps during review.
- [Diagnosis](https://polyai-mintlify-7055a538.mintlify.site/analytics/conversations/diagnosis.md): Toggle diagnostic layers to inspect tool calls, flows, latency, and topic citations on the Transcription tab.
- [Behavior](https://polyai-mintlify-7055a538.mintlify.site/behavior/introduction.md): Set and edit your agent's global rules, model, personality, and fixed greeting line.
- [Agent](https://polyai-mintlify-7055a538.mintlify.site/behavior/general/agent.md): Define your agent's personality and role.
- [Rules](https://polyai-mintlify-7055a538.mintlify.site/behavior/general/rules.md): Set global rules to control your agent behavior, tone, and compliance.
- [Multi-language](https://polyai-mintlify-7055a538.mintlify.site/behavior/language/multilingual.md): Configure your agent to handle conversations in multiple languages from a single project.
- [Language coverage](https://polyai-mintlify-7055a538.mintlify.site/behavior/language/language-coverage.md): Languages and models supported across LLM, ASR, and TTS on the PolyAI platform.
- [Translations](https://polyai-mintlify-7055a538.mintlify.site/behavior/language/translations.md): Manually override auto-translated content for multilingual agents.
- [Guardrails](https://polyai-mintlify-7055a538.mintlify.site/behavior/guardrails/introduction.md): Platform safety guardrails that protect your agent in production, with observability in conversation transcripts.
- [Safety filters](https://polyai-mintlify-7055a538.mintlify.site/behavior/guardrails/safety-filters.md): Per-channel content filters that classify user input and agent output across hate, sexual, violence, and self-harm – and always-on jailbreak detection.
- [Model](https://polyai-mintlify-7055a538.mintlify.site/behavior/models/model-use.md): Choose which LLM powers your agent – including PolyAI Raven, our proprietary model family built for conversational AI.
- [Raven](https://polyai-mintlify-7055a538.mintlify.site/behavior/models/raven.md): PolyAI's proprietary LLM family, built for customer service across voice and chat.
- [Bring your own model (BYOM)](https://polyai-mintlify-7055a538.mintlify.site/behavior/models/byom.md): Connect your own LLM endpoint to PolyAI.
- [FAQs](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/introduction.md): Create curated FAQ topics with sample questions, answers, and actions to handle common caller requests.
- [RAG](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/RAG/introduction.md): How retrieval-augmented generation powers topic matching.
- [Actions](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/actions/introduction.md): Guide to setting up actions for SMS, functions, and handoffs
- [Send SMS](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/actions/send-sms.md): Trigger an SMS directly from Managed Topic actions
- [Invoke tool](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/actions/tool-call.md): Invoke a tool (Python function) from a managed-topic action to extend your agent with custom logic.
- [Handoff](https://polyai-mintlify-7055a538.mintlify.site/knowledge/faqs/actions/handoff.md): Trigger call handoffs from Managed Topic actions
- [Sources](https://polyai-mintlify-7055a538.mintlify.site/knowledge/sources/introduction.md): Manage multiple external knowledge sources (sources) to inform your agent's responses.
- [Variants](https://polyai-mintlify-7055a538.mintlify.site/knowledge/variants/introduction.md): Manage multi-site configurations for a single agent.
- [CSV imports](https://polyai-mintlify-7055a538.mintlify.site/knowledge/variants/csv-imports.md): Bulk import and update variants using CSV files
- [Flows](https://polyai-mintlify-7055a538.mintlify.site/flows/introduction.md): Use flows to guide callers through structured, multi-step processes with validation and branching logic.
- [Triggering flows](https://polyai-mintlify-7055a538.mintlify.site/flows/triggering-flows.md): Start flows from FAQs, global functions, or transition functions using conv.goto_flow().
- [Example flow](https://polyai-mintlify-7055a538.mintlify.site/flows/example.md): A complete reservation confirmation flow showing prompts, transitions, and ASR biasing patterns.
- [No-code flows](https://polyai-mintlify-7055a538.mintlify.site/flows/no-code/introduction.md): Build conversational workflows visually using Default steps and entity extraction without Python.
- [Entities](https://polyai-mintlify-7055a538.mintlify.site/flows/no-code/entities.md): Define and validate structured data types like names, dates, and phone numbers in flow steps.
- [Quickstart](https://polyai-mintlify-7055a538.mintlify.site/flows/no-code/quickstart.md): Build your first no-code flow step by step with Default steps and routing.
- [Advanced steps](https://polyai-mintlify-7055a538.mintlify.site/flows/no-code/advanced-steps.md): Enable ASR biasing, DTMF collection, and function references in flow steps for precise control.
- [Transition functions](https://polyai-mintlify-7055a538.mintlify.site/flows/transition-functions.md): Use transition functions to control how your agent moves between steps and flows
- [Flow object](https://polyai-mintlify-7055a538.mintlify.site/flows/object.md): The Flow object controls step transitions and exposes the current step name in a flow.
- [ASR biasing](https://polyai-mintlify-7055a538.mintlify.site/flows/asr-biasing.md): Configure flow steps to improve speech recognition accuracy for structured inputs like codes and names.
- [DTMF](https://polyai-mintlify-7055a538.mintlify.site/flows/dtmf.md): Collect keypad input in flow steps with configurable digit limits, timeouts, and optional recording opt-out.
- [Few-shot prompting](https://polyai-mintlify-7055a538.mintlify.site/flows/few-shot-prompting.md): Guide the LLM with example user inputs and expected agent responses to improve accuracy in flows and topics.
- [Tools](https://polyai-mintlify-7055a538.mintlify.site/tools/introduction.md): Add custom logic and API integrations using Python functions.
- [Create tool](https://polyai-mintlify-7055a538.mintlify.site/tools/how-to-setup.md): Write Python functions with parameters and return values to integrate APIs and business logic.
- [Using tools](https://polyai-mintlify-7055a538.mintlify.site/tools/using-tools-in-knowledge-base.md): Attach functions to FAQs actions to call APIs and perform logic when topics match.
- [Start tool](https://polyai-mintlify-7055a538.mintlify.site/tools/start-tool.md): Initialize conversation state, read SIP headers, and set variant routing before the greeting plays.
- [End tool](https://polyai-mintlify-7055a538.mintlify.site/tools/end-tool.md): Run post-call processing asynchronously after a conversation ends.
- [Variables](https://polyai-mintlify-7055a538.mintlify.site/tools/variables.md): Store and access data across conversation turns using the conv.state object in functions.
- [Return values](https://polyai-mintlify-7055a538.mintlify.site/tools/return-values.md): Control agent behavior with strings, utterances, handoffs, and other return types from functions.
- [Libraries](https://polyai-mintlify-7055a538.mintlify.site/tools/import-library.md): Standard library and pre-installed packages available to functions, including requests, jsonschema, and urllib3.
- [Delay control](https://polyai-mintlify-7055a538.mintlify.site/tools/delay-control.md): Play interim filler phrases while functions execute to keep callers engaged and avoid silence.
- [Tool classes](https://polyai-mintlify-7055a538.mintlify.site/tools/classes.md): Use Conversation, Voice, and utility classes to manage state and configure TTS providers in functions.
- [Conversation](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/conv-object.md): The Conversation object, its attributes, and methods.
- [Conversation utilities](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/conv-utils.md): Access secrets and helper methods for extracting addresses and other structured data from conv.utils.
- [Conversation API client](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/conv-api.md): Call configured APIs from functions using conv.api with automatic environment and auth handling.
- [Conversation log](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/conv-log.md): Write structured log entries visible in Conversation Review diagnostics using conv.log methods.
- [ASR biasing from functions](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/asr-from-conv.md): Set and clear speech recognition biasing at runtime using conv.set_asr_biasing() for dynamic vocabulary.
- [Disable knowledge topics from functions](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/disable-kb-topics.md): Exclude specific FAQs from RAG retrieval at runtime using conv.disable_kb_topics() based on conversation context.
- [History](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/history.md): Access conversation turn history as UserInput and AgentResponse objects from conv.history.
- [Voice](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/voice.md): Configure TTS providers like ElevenLabs and Cartesia programmatically using voice classes.
- [Agent memory](https://polyai-mintlify-7055a538.mintlify.site/tools/classes/agent-memory.md): Remember information about returning callers across separate conversations using persistent key-value storage.
- [Extend with code](https://polyai-mintlify-7055a538.mintlify.site/extend/introduction.md): Write Python functions to integrate APIs, validate input, and add custom business logic to your agent.
- [Agent Development Kit (ADK)](https://polyai-mintlify-7055a538.mintlify.site/extend/adk.md): Python CLI for building, managing, and deploying PolyAI agents locally with a Git-like pull-edit-push workflow.
- [Testing](https://polyai-mintlify-7055a538.mintlify.site/testing/introduction.md): Validate your agent before and after going live with simulation tests and A/B experiments.
- [Simulation tests](https://polyai-mintlify-7055a538.mintlify.site/testing/simulation-tests.md): Author scenario-based tests with assertions, tags, and system actions.
- [Run and review](https://polyai-mintlify-7055a538.mintlify.site/testing/run-and-review.md): Execute simulation tests, inspect results, and organize tests into sets.
- [A/B testing](https://polyai-mintlify-7055a538.mintlify.site/testing/ab-testing.md): Run two live agent versions in parallel, split real traffic between them, and pick a winner based on real performance data.
- [Automate with API](https://polyai-mintlify-7055a538.mintlify.site/testing/ci-automation.md): Gate deployments on simulation test results using the Agents API.
- [Real-time config](https://polyai-mintlify-7055a538.mintlify.site/real-time-config/introduction.md): Let non-technical managers update agent settings without publishing new versions using structured configuration forms.
- [Voice](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/introduction.md): Configure how your agent sounds and how it listens.
- [Voice settings](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/agent.md): Configure your agent's voice, greeting, disclaimer, and style prompt.
- [Handoff](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/handoffs.md): Set up handoff destinations to transfer users to human agents during conversations.
- [Message templates](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/message-templates.md): Send SMS messages from your agent using Twilio for confirmations, links, and follow-ups
- [Number availability & compliance](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/number-availability.md): Country-by-country Twilio number availability, throughput limits, lead times, and regulatory links for 2-way SMS.
- [Audio library](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/audio-library.md): Manage cached audio files to reduce voice latency.
- [Voice library](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/voice-library.md): Browse, preview, and select voices for your agent.
- [Choosing a good voice](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/choosing-a-good-voice.md): Guidelines for selecting the right voice for your agent.
- [Use more than one voice](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/multi-voice.md): Assign multiple voices to simulate a team of agents.
- [Add a voice](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/add-a-new-voice.md)
- [Custom voice](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/custom-voice-request.md): Commission a brand-exclusive custom voice for enterprise accounts.
- [Numbers](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/introduction.md): Connect phone numbers to your agent using PolyAI, Twilio, or outbound calling
- [Buy a number from PolyAI](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/how-to-buy-number.md): Purchase phone numbers directly in Agent Studio.
- [Phone numbers](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/route-management.md): Add, manage, and track phone numbers used by your agent.
- [Outbound calling](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/outbound-calling.md): Configure outbound calls for appointment reminders, follow-ups, and notifications
- [Twilio](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/twilio/introduction.md): Connect your Twilio account to use existing phone numbers and SMS with PolyAI
- [Phone number integration](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/twilio/how-to-integrate-voice.md): Integrate a Twilio phone number with PolyAI Agent Studio
- [Handoff integration](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/numbers/twilio/how-to-handoff.md): Set up handoff destinations with Twilio
- [Advanced voice settings](https://polyai-mintlify-7055a538.mintlify.site/voice-channel/advanced/call-settings.md): Configure model selection, barge-in, filler phrases, safety filters, keyphrases, transcript corrections, and pronunciation for voice agents.
- [Web Chat](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/introduction.md): Deploy a webchat version of your agent alongside voice.
- [Messaging Agent Configuration](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/advanced/chat-configuration.md): Configure LLM, greeting, and safety filters across messaging channels in Agent Studio.
- [Disclaimers and privacy policies](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/advanced/disclaimers-and-privacy-policies.md): Configure the legal disclosures your web chat shows, where they appear, and whether users must accept them before chatting.
- [Web chat localisation](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/advanced/localisation.md): Localise your web chat widget experience to serve customers in multiple languages.
- [Verified Context Injection](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/advanced/verified-context-injection.md): Pass verified user context (e.g. signed-in identity) into your web chat agent securely at session start.
- [Multichannel agents](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/multichannel.md): Build agents that work across voice and webchat from a single project.
- [SMS](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/sms-and-rcs/sms.md): Deploy your agent over SMS with the same brain that powers voice and web chat.
- [RCS](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/sms-and-rcs/rcs.md): Deploy your agent over RCS to bring rich, branded messaging to Android and iOS users.
- [SMS & RCS Registration](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/sms-and-rcs/sms-and-rcs-campaign-registration-compliance-requirements-us.md)
- [SMS Agent Configuration](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/sms-and-rcs/advanced/sms-agent-configuration.md): Configure your SMS agent's behavior, style, and responses.
- [iOS SDK](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/ios-sdk.md): Embed a PolyAI messaging agent natively in your iOS app with a headless Swift library.
- [Voice calling (iOS SDK)](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/ios-sdk-voice.md): Add live two-way WebRTC voice calls to your iOS app with PolyVoice.
- [Android SDK](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/android-sdk.md): Embed a PolyAI messaging agent natively in your Android app with a headless Kotlin library.
- [Voice calling (Android SDK)](https://polyai-mintlify-7055a538.mintlify.site/messaging-channel/android-sdk-voice.md): Add live two-way WebRTC voice calls to your Android app with ai.poly:voice.
- [Integrations](https://polyai-mintlify-7055a538.mintlify.site/integrations/introduction.md): Connect PolyAI to your existing platforms: telephony, CRM, payments, and knowledge systems.
- [API integrations](https://polyai-mintlify-7055a538.mintlify.site/integrations/api/introduction.md): Define and call external APIs directly from Agent Studio without writing custom HTTP request code.
- [Chat handoff integrations](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/introduction.md): Hand off webchat and SMS conversations from your PolyAI agent to a live agent in your CCaaS or CRM.
- [Salesforce chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/salesforce.md): Hand off a webchat or SMS conversation from PolyAI to a Salesforce Service Cloud Messaging agent.
- [Zendesk chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/zendesk.md): Hand off a webchat or SMS conversation from PolyAI to a Zendesk Messaging agent.
- [NICE CXone chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/nice-cxone.md): Hand off a webchat or SMS conversation from PolyAI to a NICE CXone Digital agent.
- [Amazon Connect chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/amazon-connect.md): Hand off a webchat or SMS conversation from PolyAI to an Amazon Connect chat agent.
- [Webex by Cisco chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/webex.md): Hand off a webchat or SMS conversation from PolyAI to a Webex Contact Center agent.
- [Genesys Cloud](https://polyai-mintlify-7055a538.mintlify.site/integrations/messaging/genesys.md): Connect a Genesys Cloud org to PolyAI Agent Studio via Open Messaging, with handoff routed to an ACD queue.
- [Five9 chat handoff](https://polyai-mintlify-7055a538.mintlify.site/integrations/chat/five9.md): Hand off a webchat or SMS conversation from PolyAI to a Five9 agent.
- [Deployments](https://polyai-mintlify-7055a538.mintlify.site/environments-and-versions/introduction.md): Learn how to ship safely: branch, promote, A/B test, and roll back from one timeline.
- [Compare versions](https://polyai-mintlify-7055a538.mintlify.site/environments-and-versions/diffs.md): Use side-by-side diffs to compare versions and track changes across your entire project.
- [Widgets](https://polyai-mintlify-7055a538.mintlify.site/widgets/introduction.md): One unified surface for embedding PolyAI on your website. Pick Phone or Chat as the widget type.
- [Web Calling](https://polyai-mintlify-7055a538.mintlify.site/widgets/web-calling.md): A voice widget your visitors click to talk to your agent. End-to-end browser audio, no phone numbers.
- [Configure widget](https://polyai-mintlify-7055a538.mintlify.site/widgets/configure.md): Brand your widget, write the copy, set up consent. One editor for Phone and Chat.
- [Install on your site](https://polyai-mintlify-7055a538.mintlify.site/widgets/install.md): Embed your widget on your website. Single script tag, live in minutes.
- [Test your widget](https://polyai-mintlify-7055a538.mintlify.site/widgets/test.md): Open a hosted preview of your Phone widget and place an end-to-end call before embedding.
- [Share your agent](https://polyai-mintlify-7055a538.mintlify.site/widgets/share.md): Three ways to get your voice agent in front of someone: a link, a widget on your site, or a custom trigger via the Web Calling JavaScript API.
- [Troubleshooting](https://polyai-mintlify-7055a538.mintlify.site/widgets/troubleshooting.md): Diagnose widget issues: rendering, microphone, network, CSP, and call-quality problems.
- [Account](https://polyai-mintlify-7055a538.mintlify.site/settings/introduction.md): Account settings: safety filters, defaults, and admin controls.
- [User management](https://polyai-mintlify-7055a538.mintlify.site/user-management/introduction.md): Manage team access and permissions for your PolyAI account.
- [Role permissions](https://polyai-mintlify-7055a538.mintlify.site/user-management/access-control-scope.md): Reference guide for granular permissions and role-based access control.
- [How to invite users](https://polyai-mintlify-7055a538.mintlify.site/user-management/invite-users.md): Add team members to your account with role-based permissions.
- [Overview](https://polyai-mintlify-7055a538.mintlify.site/secrets/introduction.md): Store API keys and credentials securely in the Secrets Vault.
- [How to create a secret](https://polyai-mintlify-7055a538.mintlify.site/secrets/how-to-setup.md): Create a secret in the Secrets Vault
- [Access control](https://polyai-mintlify-7055a538.mintlify.site/secrets/how-to-access-control.md): Manage which agents can access secrets
- [API keys](https://polyai-mintlify-7055a538.mintlify.site/secrets/api-keys.md): Create and manage API keys for accessing PolyAI's external APIs.
- [Recordings and transcripts](https://polyai-mintlify-7055a538.mintlify.site/call-data/introduction.md): Access call recordings, transcripts, and metadata for compliance, QA, and performance analysis.
- [Studio transcripts](https://polyai-mintlify-7055a538.mintlify.site/call-data/studio-transcripts.md): Access conversation transcripts and recordings directly in Agent Studio for compliance, QA, and analysis.
- [Handoff States](https://polyai-mintlify-7055a538.mintlify.site/call-data/conversations-api/handoff-states.md): Retrieve the handoff state and context written by your agent when a conversation transitions to a live agent.
- [List conversations](https://polyai-mintlify-7055a538.mintlify.site/call-data/conversations-api/list-conversations.md): Retrieve conversation transcripts and metadata programmatically using the Conversations API.
- [AWS S3 integration](https://polyai-mintlify-7055a538.mintlify.site/call-data/s3-to-s3.md): Automatically sync call recordings and transcripts to your S3 bucket for long-term storage and compliance.
- [Compliance](https://polyai-mintlify-7055a538.mintlify.site/legal/compliance.md): Our global standards and certifications for data security and privacy.
- [Training data](https://polyai-mintlify-7055a538.mintlify.site/legal/training-data.md): Information on the datasets used for our proprietary LLM, PolyAI Raven
- [PolyAcademy: Learn to build voice agents](https://polyai-mintlify-7055a538.mintlify.site/learn/guides/polyacademy.md): Free, hands-on tutorials for building voice agents in Agent Studio. Go from beginner to expert at your own pace – no coding required to start.
- [Home](https://polyai-mintlify-7055a538.mintlify.site/learn/guides/introduction.md): Learn to build, configure, and maintain production-ready voice agents through hands-on guides across three skill levels.
- [Design principles](https://polyai-mintlify-7055a538.mintlify.site/learn/guides/design-principles.md): Core priorities and practical guidelines for building agents that work well.
- [Get started](https://polyai-mintlify-7055a538.mintlify.site/learn/guides/get-started.md): Build your first working agent – from blank project to testable voice assistant in about 30 minutes.
- [Recipes](https://polyai-mintlify-7055a538.mintlify.site/learn/recipes/introduction.md): Copy-paste patterns for common voice agent workflows — tested, annotated, and ready to adapt.
- [Already have an agent?](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/introduction.md): Quick-reference maintenance guides for keeping your live agent running smoothly.
- [Improve your agent after a real call](https://polyai-mintlify-7055a538.mintlify.site/learn/iterate-open-platform.md): Read the transcript, find the failure, ask Wren to fix it. The loop that gets the agent from working to actually good.
- [Maintaining FAQs](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/knowledge-base.md): Quickly edit, add, or bulk-update FAQs – the agent's FAQ and knowledge.
- [Maintaining Sources](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/knowledge-connected-knowledge.md): Sync and manage external knowledge sources – websites, files, and integrations – to keep content current.
- [Voice and audio updates](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/voice-audio-updates.md): Change voice, fix pronunciations, adjust latency, and manage cached audio for optimal voice quality.
- [Tool maintenance](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/tool-maintenance.md): Update tool code (Python functions), debug errors using logs, manage credentials, and fix integration issues.
- [Multi-language updates](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/multi-language-updates.md): Add languages, update language-specific knowledge and voices, and manage pronunciation rules per language.
- [Performance monitoring](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/performance-monitoring.md): Track latency, containment, and ASR accuracy – use dashboards and Wren for deep insights.
- [Version management](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/version-management.md): Publish, promote through environments, compare versions, and rollback safely when needed.
- [Health checks](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/health-checks.md): Daily, weekly, and monthly monitoring routines to keep your live agent running smoothly and reliably.
- [Routing and handoffs](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/routing-handoffs.md): Update handoff destinations, manage SIP routing, and test transfers without disrupting live traffic."
- [Temporary closures](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/temporary-closures.md): Close your agent early or play a closure message for same-day schedule changes.
- [QA and analytics](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/qa-analytics.md): Review conversations, analyze dashboards, and ask Wren for insights across hundreds of calls.
- [Common issues](https://polyai-mintlify-7055a538.mintlify.site/learn/maintain/common-issues.md): Diagnose and fix the most frequent agent issues with step-by-step troubleshooting.
- [Glossary](https://polyai-mintlify-7055a538.mintlify.site/glossary/introduction.md): Definitions of key terms used in the PolyAI Agent Studio.
- [Architecture overview](https://polyai-mintlify-7055a538.mintlify.site/glossary/architecture.md): Understand how PolyAI agents process conversations from start to finish.
- [Conversation flow](https://polyai-mintlify-7055a538.mintlify.site/essentials/order.md): How PolyAI agents process conversations.
- [Frequently asked questions](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq.md): Common questions and troubleshooting solutions for agent configuration, knowledge, rules, and actions.
- [Managed topics FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-managed-topics.md): Guidance on structuring topics, optimizing retrieval, and scaling topic management.
- [Connected knowledge FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-connected-knowledge.md): Learn when to use Connected Knowledge, how it differs from Managed Topics, and how to troubleshoot retrieval.
- [Behavior FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-rules.md): Guidance on writing effective behavioral rules, channel filtering, and handling edge cases.
- [Actions FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-actions.md): Common questions about configuring actions, combining them, using variables, and debugging failures.
- [Personality and role FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-personality.md): Learn how to configure your agent's personality, tone, and role using concrete examples.
- [Environments and testing FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-environments.md): Guidance on safe testing, deployment pipelines, and managing multi-site agents.
- [Technical considerations FAQ](https://polyai-mintlify-7055a538.mintlify.site/troubleshoot/faq-technical.md): Answers on ASR/TTS independence, token limits, and context management best practices.
- [PolyAI ADK Docs](https://polyai-mintlify-7055a538.mintlify.site/adk/index.md)
- [Getting started with PolyAI](https://polyai-mintlify-7055a538.mintlify.site/adk/get-started/get-started.md)
- [What is the PolyAI ADK?](https://polyai-mintlify-7055a538.mintlify.site/adk/get-started/what-is-the-adk.md)
- [Walkthrough Video](https://polyai-mintlify-7055a538.mintlify.site/adk/get-started/walkthrough-video.md)
- [Prerequisites](https://polyai-mintlify-7055a538.mintlify.site/adk/get-started/prerequisites.md)
- [First commands](https://polyai-mintlify-7055a538.mintlify.site/adk/get-started/first-commands.md)
- [Tutorials](https://polyai-mintlify-7055a538.mintlify.site/adk/tutorials/index.md)
- [Build an agent with the ADK](https://polyai-mintlify-7055a538.mintlify.site/adk/tutorials/build-an-agent.md)
- [Build a restaurant booking agent](https://polyai-mintlify-7055a538.mintlify.site/adk/tutorials/restaurant-booking-agent.md)
- [Working locally](https://polyai-mintlify-7055a538.mintlify.site/adk/concepts/working-locally.md)
- [Resource architecture](https://polyai-mintlify-7055a538.mintlify.site/adk/concepts/resource-architecture.md)
- [Multi-user workflows and guardrails](https://polyai-mintlify-7055a538.mintlify.site/adk/concepts/multi-user-and-guardrails.md)
- [Common anti-patterns](https://polyai-mintlify-7055a538.mintlify.site/adk/concepts/anti-patterns.md)
- [Examples](https://polyai-mintlify-7055a538.mintlify.site/adk/examples/index.md)
- [Confirm caller ID before sending SMS](https://polyai-mintlify-7055a538.mintlify.site/adk/examples/confirm-caller-id-before-sms.md)
- [Venue-specific goodbye with clean hangup](https://polyai-mintlify-7055a538.mintlify.site/adk/examples/venue-specific-goodbye.md)
- [SMS link with transfer fallback](https://polyai-mintlify-7055a538.mintlify.site/adk/examples/sms-or-transfer-fallback.md)
- [CLI reference](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/cli.md)
- [Branch merging](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/branch_merge.md)
- [Tests](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/tests.md)
- [Tooling](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/tooling.md)
- [Agent settings](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/agent_settings.md)
- [Voice settings](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/voice_settings.md)
- [Chat settings](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/chat_settings.md)
- [Safety filters](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/safety_filters.md)
- [Languages](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/languages.md)
- [Experimental config](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/experimental_config.md)
- [Flows](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/flows.md)
- [Functions](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/functions.md)
- [Topics](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/topics.md)
- [Entities](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/entities.md)
- [Variables](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/variables.md)
- [Variants](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/variants.md)
- [Handoffs](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/handoffs.md)
- [SMS templates](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/sms.md)
- [Translations](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/translations.md)
- [Speech recognition](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/speech_recognition.md)
- [Response control](https://polyai-mintlify-7055a538.mintlify.site/adk/reference/response_control.md)
- [Discord](https://polyai-mintlify-7055a538.mintlify.site/adk/community/discord.md)
- [License acknowledgements](https://polyai-mintlify-7055a538.mintlify.site/adk/legal/licensing.md)
- [API reference](https://polyai-mintlify-7055a538.mintlify.site/api-reference/introduction.md): Build, run, and observe PolyAI agents from your own systems. Three API families, one platform, 99.994% uptime in production.
- [API quickstart](https://polyai-mintlify-7055a538.mintlify.site/api-reference/quickstart.md): Build a PolyAI agent from the API: create it, configure its behavior and knowledge, test it in a live conversation, and ship it to production.
- [Error codes](https://polyai-mintlify-7055a538.mintlify.site/api-reference/error-codes.md): HTTP status codes and platform-specific error codes returned by PolyAI APIs.
- [Agents API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/introduction.md): Build, configure, and deploy PolyAI agents programmatically. Manage agents, branches, knowledge bases, telephony, and deployments from your own systems.
- [List agents](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/agents/list-agents.md)
- [Create agent](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/agents/create-agent.md)
- [Duplicate agent](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/agents/duplicate-agent.md)
- [Delete agent](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/agents/delete-agent.md)
- [List branches](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/branches/list-branches.md)
- [Create branch](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/branches/create-branch.md)
- [Merge branch](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/branches/merge-branch.md)
- [Delete branch](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/branches/delete-branch.md)
- [Get agent behavior rules](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/behavior/get-agent-behavior-rules.md)
- [Update agent behavior rules](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/behavior/update-agent-behavior-rules.md)
- [List knowledge base topics](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/knowledge-base/list-knowledge-base-topics.md)
- [Create knowledge base topic](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/knowledge-base/create-knowledge-base-topic.md)
- [Get knowledge base topic](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/knowledge-base/get-knowledge-base-topic.md)
- [Update knowledge base topic](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/knowledge-base/update-knowledge-base-topic.md)
- [Delete knowledge base topic](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/knowledge-base/delete-knowledge-base-topic.md)
- [List attributes](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/list-attributes.md)
- [Create attribute](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/create-attribute.md)
- [Update attribute](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/update-attribute.md)
- [Delete attribute](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/delete-attribute.md)
- [List variants](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/list-variants.md)
- [Create variant](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/create-variant.md)
- [Update variant](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/update-variant.md)
- [Delete variant](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/variants/delete-variant.md)
- [List deployments for an environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/deployments/list-deployments-for-an-environment.md)
- [Get active deployment per environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/deployments/get-active-deployment-per-environment.md)
- [Publish the current draft to an environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/deployments/publish-the-current-draft-to-an-environment.md)
- [Promote a deployment to the next environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/deployments/promote-a-deployment-to-the-next-environment.md)
- [Rollback to a previous deployment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/deployments/rollback-to-a-previous-deployment.md)
- [List all connectors for a project](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/list-all-connectors-for-a-project.md)
- [Get a connector by ID](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/get-a-connector-by-id.md)
- [Update a connector](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/update-a-connector.md)
- [Delete a connector and its phone numbers](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/delete-a-connector-and-its-phone-numbers.md)
- [Batch get connectors by ID](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/batch-get-connectors-by-id.md)
- [Batch update connectors](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/batch-update-connectors.md)
- [Look up connector by phone number](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/connectors/look-up-connector-by-phone-number.md)
- [Trigger an outbound call](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/outbound-calls/trigger-outbound-call.md): Triggers the PolyAI voice agent to dial a phone number. The agent will call the provided number and conduct the conversation autonomously. Returns a callSid that can be used to poll status.
- [Get the status of an outbound call](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/outbound-calls/get-outbound-call-status.md): Retrieves the current status of an outbound call. Call status data is retained for approximately 2 hours after the call ends.
- [List all phone numbers for a project](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/list-all-phone-numbers-for-a-project.md)
- [Import phone numbers into a project](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/import-phone-numbers-into-a-project.md)
- [Import a single phone number](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/import-a-single-phone-number.md)
- [Get a specific phone number](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/get-a-specific-phone-number.md)
- [Reassign a phone number to a different connector](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/reassign-a-phone-number-to-a-different-connector.md)
- [Delete a single phone number](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/delete-a-single-phone-number.md)
- [Delete phone numbers from a project](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/delete-phone-numbers-from-a-project.md)
- [Batch get phone numbers](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/phone-numbers/batch-get-phone-numbers.md)
- [List all config pages](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/real-time-configs/list-all-config-pages.md)
- [Get a config page by environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/real-time-configs/get-a-config-page-by-environment.md)
- [Upsert the JSON Schema for a config page](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/real-time-configs/upsert-the-json-schema-for-a-config-page.md)
- [Update config variables for an environment](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/real-time-configs/update-config-variables-for-an-environment.md)
- [List voices](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/voice-library/list-voices.md)
- [Register a voice](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/voice-library/register-voice.md)
- [Get a voice](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/voice-library/get-voice.md)
- [Update a voice](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/voice-library/update-voice.md)
- [Synthesize a voice sample](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/voice-library/synthesize-voice-sample.md)
- [List cached audio entries](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/list-audio-cache.md): List cached TTS audio entries for an agent with metadata including transcript, provider, voice, duration, and hit count.
- [Download cached audio file](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/download-audio-file.md): Download the cached audio file as a WAV binary. Returns the raw audio bytes for the given cache entry ID.
- [Replace cached audio file](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/replace-audio-file.md): Replace the audio file for an existing cache entry. Send raw WAV bytes as the request body with `Content-Type: audio/wav`. Optionally include an `X-Filename` header to name the file, otherwise defaults to `<entryId>.wav`. Maximum file size is 6 MB.
- [Replace audio and voice tuning settings](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/update-audio-cache-details.md): Replace both the audio file and voice tuning settings for a cache entry in a single request. Sent as `multipart/form-data` with a `file` part containing the WAV audio (max 6 MB) and a `settings` part containing a JSON object with `text` and `config` fields.
- [Synthesize audio preview](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/synthesize-audio-preview.md): Generate a TTS audio preview using an existing cache entry's voice and provider configuration. Returns WAV audio without saving to cache, allowing you to preview how different text or tuning settings would sound before committing changes.
- [Delete a cached audio entry](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/delete-audio-cache-entry.md): Delete a cached audio entry and its associated audio file from storage. The entry is permanently removed and cannot be recovered.
- [Bulk delete cached audio entries](https://polyai-mintlify-7055a538.mintlify.site/api-reference/agents/endpoint/audio-cache/bulk-delete-audio-cache.md): Delete multiple audio cache entries by ID in a single request. Operates best-effort — returns which IDs were successfully deleted and which failed, so partial failures can be retried. Maximum 20 IDs per request.
- [Debug Chat API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/debug-chat/introduction.md): Create and exchange messages in debug chat sessions to test agent variants outside of production traffic.
- [Create a new debug chat session](https://polyai-mintlify-7055a538.mintlify.site/api-reference/debug-chat/create-debug-chat-session.md): Start a new debug chat session to interactively test an agent variant outside of production traffic. Served from api.{region}.poly.ai.
- [Send a message to a debug chat session](https://polyai-mintlify-7055a538.mintlify.site/api-reference/debug-chat/send-debug-chat-message.md): Send a user turn into an existing debug chat session and return the agent's response. Served from api.{region}.poly.ai.
- [Chat API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/chat/introduction.md): Use the Chat API to power webchat, in-browser widgets, web SDK implementations, and SMS conversations.
- [Create a chat](https://polyai-mintlify-7055a538.mintlify.site/api-reference/chat/endpoint/create-a-chat.md): Creates a new chat conversation and returns the conversation ID along with the agent's initial response.
- [Respond to a chat](https://polyai-mintlify-7055a538.mintlify.site/api-reference/chat/endpoint/respond-to-a-chat.md): Sends a user message to an existing conversation and returns the agent's response.
- [Close a chat](https://polyai-mintlify-7055a538.mintlify.site/api-reference/chat/endpoint/close-a-chat.md): Closes an active chat conversation and marks it as complete.
- [Concurrent Calls API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/concurrent-calls/introduction.md): Track concurrent conversations over time for capacity planning and monitoring.
- [Get max concurrent call numbers](https://polyai-mintlify-7055a538.mintlify.site/api-reference/concurrent-calls/endpoint/get-max-concurrent.md): Returns the maximum number of concurrent conversations in several 5-minute intervals based on the given parameters.
- [Conversations API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/conversations/introduction.md): Retrieve conversation transcripts, metadata, and performance metrics for analytics, compliance, and integration.
- [List all conversations](https://polyai-mintlify-7055a538.mintlify.site/api-reference/conversations/v3/endpoint/get-conversations.md): Retrieves conversations for a given account and project. Supports three retrieval modes: transcript search, semantic search, and random sampling. When no retrieval mode is specified, the endpoint returns all conversations matching the given filters (default behavior). Only one retrieval mode may be…
- [Get a conversation by ID](https://polyai-mintlify-7055a538.mintlify.site/api-reference/conversations/v3/endpoint/get-conversation-by-id.md): Retrieve a single conversation, including turns, metrics, and function events. Served from api.{region}.poly.ai, not the api.{region}-1.platform.polyai.app host.
- [Get audio recording for a conversation](https://polyai-mintlify-7055a538.mintlify.site/api-reference/conversations/v3/endpoint/get-conversation-audio.md): Fetch the WAV audio recording for a conversation. Served from api.{region}.poly.ai. Users without PII access automatically receive the redacted recording.
- [DNI API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/dni/introduction.md): Reserve dynamic phone numbers with attached context for marketing, CRM, and web-to-call integrations.
- [Reserve DNI](https://polyai-mintlify-7055a538.mintlify.site/api-reference/dni/endpoint/dni-reservation.md): Reserves a DNI, associating a temporary set of attributes to a specific virtual agent.
- [External Events API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/external-events/introduction.md): Feed external results (payments, bookings, verifications) back into active conversations asynchronously.
- [Post external event result](https://polyai-mintlify-7055a538.mintlify.site/api-reference/external-events/endpoint/webhook.md): External providers POST results back to the Agent runtime. PolyAI extracts the external event ID according to the query parameters, binds the data to the active conversation, and (optionally) feeds it to the LLM.
- [Bridge ended notification](https://polyai-mintlify-7055a538.mintlify.site/api-reference/external-events/endpoint/bridge-ended.md): Internal endpoint that receives notifications when a call bridge (transfer) completes. Triggered automatically by the telephony system after a bridged call ends, allowing configured project functions to process bridge metadata and call duration information.
- [Handoff API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/handoff/introduction.md): Retrieve conversation context and metadata when PolyAI agents hand off to live agents or external systems.
- [Get handoff state](https://polyai-mintlify-7055a538.mintlify.site/api-reference/handoff/endpoint/get-handoff.md): Returns the stored handoff state for a conversation. At least one of **id** or **shared_id** must be provided as a query parameter. If both are provided, **shared_id** takes precedence.
- [Messaging API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/introduction.md): Embed real-time text conversations into your application using WebSockets, with handoff to live agents.
- [Sessions and authentication](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/sessions.md): Exchange your connector token for a short-lived access token, then create a session.
- [WebSocket connection](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/websocket.md): Connect, reconnect, and keep the WebSocket alive.
- [Event format](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/events.md): The common JSON envelope used for every WebSocket event.
- [Client events](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/events-send.md): Events your client can send over the WebSocket.
- [Server events](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/events-receive.md): Events your client receives over the WebSocket.
- [Streaming](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/streaming.md): Receive agent responses as incremental chunks, like ChatGPT's typing effect.
- [Handoff to live agent](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/handoff.md): Transfer the conversation from the PolyAI agent to a human agent.
- [Session lifecycle](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/lifecycle.md): Every event in order, from connection through session end.
- [Errors](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/errors.md): HTTP status codes and system-message error catalog.
- [Best practices](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/best-practices.md): Recommendations for connection management, message handling, UX, and security.
- [Enable Verified Context Injection](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/enable-verified-context-injection.md): Enable and configure verified context injection for your Messaging API sessions.
- [SMS API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/sms-and-rcs-api/introduction.md): Send and receive SMS messages through your PolyAI agent.
- [Send an outbound SMS/RCS](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/sms-and-rcs-api/send-sms.md): Send an outbound SMS or RCS message and open a reply-enabled conversation session.
- [RCS API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/messaging/sms-and-rcs-api/rcs.md): Send and receive rich, interactive messages (images, videos, rich cards, carousels, location pins) over RCS, with automatic SMS fallback.
- [WebRTC Gateway API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webrtc-gateway/introduction.md): Enable in-browser voice conversations with PolyAI agents using WebRTC and WebSocket signaling.
- [WebSocket signaling](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webrtc-gateway/ws/signaling.md): WebSocket signaling protocol for SDP exchange, ICE candidates, and session management.
- [Alerts API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/introduction.md): Manage alert rules and query active alerts firing on your PolyAI agents.
- [Create an alert rule](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/create-alert-rule.md): Create a new alert rule. The `account_id` is derived from the `X-API-KEY` header.
- [List alert rules](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/list-alert-rules.md): List alert rules with optional filters.
- [Get an alert rule](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/get-alert-rule.md): Get a single alert rule by its ID.
- [Update an alert rule](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/update-alert-rule.md): Update an alert rule. Only the fields included in the request body are changed.
- [Delete an alert rule](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/delete-alert-rule.md): Delete an alert rule by its ID.
- [List active alerts](https://polyai-mintlify-7055a538.mintlify.site/api-reference/alerts/endpoint/list-active-alerts.md): List alert rules that are currently in the `alert` state.
- [Webhooks API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/introduction.md): Register webhook endpoints to receive real-time signed notifications for PolyAI events.
- [Create a webhook endpoint](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/create-webhook-endpoint.md)
- [List webhook endpoints](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/list-webhook-endpoints.md)
- [Get a webhook endpoint](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/get-webhook-endpoint.md)
- [Update a webhook endpoint](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/update-webhook-endpoint.md)
- [Delete a webhook endpoint](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/delete-webhook-endpoint.md)
- [Rotate webhook signing secret](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webhooks/endpoint/rotate-webhook-signing-secret.md): Generates a new signing secret for the webhook endpoint. The previous secret is immediately invalidated.
- [Outbound Calling API](https://polyai-mintlify-7055a538.mintlify.site/api-reference/outbound/introduction.md): Trigger outbound calls and monitor status for customer outreach, reminders, and notifications.
- [Trigger an outbound call](https://polyai-mintlify-7055a538.mintlify.site/api-reference/outbound/endpoint/trigger-call.md): Initiate an outbound call to a phone number
- [Get call status](https://polyai-mintlify-7055a538.mintlify.site/api-reference/outbound/endpoint/get-call-status.md): Retrieve the current status of an outbound call
- [List all conversations](https://polyai-mintlify-7055a538.mintlify.site/api-reference/conversations/v1/endpoint/get-conversations.md): Returns all conversations matching filters.
- [MCP](https://polyai-mintlify-7055a538.mintlify.site/mcp/overview.md): PolyAI's authenticated MCP servers let any MCP client build agents and query their data. Learn the two directions MCP works and which one you need.
- [Quickstart](https://polyai-mintlify-7055a538.mintlify.site/mcp/quickstart.md): Connect one of PolyAI's MCP servers to your MCP client in one command.
- [Authentication](https://polyai-mintlify-7055a538.mintlify.site/mcp/authentication.md): Create a PolyAI account API key and configure your MCP client to authenticate against Builder MCP or Data MCP.
- [Builder MCP](https://polyai-mintlify-7055a538.mintlify.site/mcp/builder/introduction.md): Build, test, and deploy PolyAI agents from your IDE or MCP client, without calling the API directly.
- [Capabilities](https://polyai-mintlify-7055a538.mintlify.site/mcp/builder/capabilities.md): The tools Builder MCP exposes, grouped by what they do — each with its parameters and a link to the matching API reference.
- [Build, test & deploy](https://polyai-mintlify-7055a538.mintlify.site/mcp/builder/walkthrough.md): An end-to-end walkthrough of building, testing, and promoting a PolyAI agent through environments with Builder MCP.
- [Security & safe use](https://polyai-mintlify-7055a538.mintlify.site/mcp/builder/security.md): How to use Builder MCP safely — least-privilege keys, gating destructive actions, and read-first workflows.
- [Data MCP](https://polyai-mintlify-7055a538.mintlify.site/mcp/data/introduction.md): Query PolyAI conversation data — transcripts, metrics, and analytics — from any MCP client.
- [Capabilities](https://polyai-mintlify-7055a538.mintlify.site/mcp/data/capabilities.md): The tools Data MCP exposes, grouped by what they do — each with its parameters.
- [Query your data](https://polyai-mintlify-7055a538.mintlify.site/mcp/data/walkthrough.md): An end-to-end walkthrough of exploring conversation data with Data MCP — from discovering metrics to reading a single transcript.
- [Security & safe use](https://polyai-mintlify-7055a538.mintlify.site/mcp/data/security.md): How to use Data MCP safely — scoping access, keeping keys secret, and handling untrusted transcript content.
- [Agent Studio MCP integrations](https://polyai-mintlify-7055a538.mintlify.site/mcp/agent-studio-integrations.md): Connect your agent to external MCP servers so it can call their tools during conversations.
- [Voice integrations](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/introduction.md): Connect PolyAI to voice platforms for call routing and SIP-based handoffs.
- [Five9](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/sip/five9.md): Connect your PolyAI agent to Five9 through a SIP trunk for call routing and handoffs.
- [NICE CXone](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/sip/NICECXone.md): Connect your PolyAI agent to NICE CXone using the Signal API.
- [Twilio](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/twilio.md): Connect your PolyAI agent to Twilio for voice automation and handoffs.
- [Amazon Connect](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/amazon-connect/amazon-connect.md): Connect your PolyAI agent to Amazon Connect for voice automation and AWS integration.
- [Genesys](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/sip/genesys.md): Connect your PolyAI agent to Genesys Cloud using BYOC service.
- [Dialpad](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/dialpad.md): Connect your PolyAI agent to Dialpad for voice automation and handoffs.
- [Zoom](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/zoom.md): Connect your PolyAI agent to Zoom Phone and Zoom Contact Center as a native third-party voice agent.
- [Salesforce](https://polyai-mintlify-7055a538.mintlify.site/integrations/salesforce.md): Connect your PolyAI agent to Salesforce for customer data lookup and case management.
- [Zendesk Talk](https://polyai-mintlify-7055a538.mintlify.site/integrations/zendesk.md): Connect to Zendesk Talk to route inbound calls and hand off calls to live agents through SIP.
- [Zendesk Ticketing Solutions](https://polyai-mintlify-7055a538.mintlify.site/integrations/zendesk-ticketing-solutions.md): Connect your PolyAI agent to Zendesk for ticket lookup, creation, and updates using API token authentication.
- [OpenTable](https://polyai-mintlify-7055a538.mintlify.site/integrations/opentable.md): Connect your PolyAI agent to OpenTable for automated restaurant reservation management.
- [Tripleseat](https://polyai-mintlify-7055a538.mintlify.site/integrations/tripleseat.md): Capture event and large party leads automatically with PolyAI and Tripleseat.
- [HotSOS](https://polyai-mintlify-7055a538.mintlify.site/integrations/hotSOS.md): Automate room service and maintenance requests with HotSOS and PolyAI.
- [Epic](https://polyai-mintlify-7055a538.mintlify.site/integrations/epic.md): Connect your PolyAI agent to Epic EHR for patient data access through SMART on FHIR.
- [Gladly](https://polyai-mintlify-7055a538.mintlify.site/integrations/gladly.md): Connect your PolyAI agent to Gladly for real-time knowledge access.
- [Managed services](https://polyai-mintlify-7055a538.mintlify.site/integrations/managed-services.md): Integrations that require coordination with your PolyAI account manager.
- [Custom SIP](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/sip/custom-sip.md): Access SIP headers for dynamic routing, personalization, and custom handoffs.
- [DNIs Pool](https://polyai-mintlify-7055a538.mintlify.site/integrations/voice/dnis-pool.md): Integrate your telephony system with PolyAI using a pool of Dynamic Number Insertion (DNI) numbers.
- [DesignMyNight](https://polyai-mintlify-7055a538.mintlify.site/integrations/design-my-night.md): Connect your PolyAI agent to DesignMyNight for restaurant and venue booking management.
- [LiveRes (Zonal)](https://polyai-mintlify-7055a538.mintlify.site/integrations/liveres.md): Connect your PolyAI agent to LiveRes for restaurant reservation management.
- [PCI Pal](https://polyai-mintlify-7055a538.mintlify.site/integrations/pci-pal.md): Integrate PCI Pal for secure, compliant payment processing during calls.
- [Stripe](https://polyai-mintlify-7055a538.mintlify.site/integrations/stripe.md): Connect your PolyAI agent to Stripe for payment status, refunds, and coupon management.
- [Google Sheets](https://polyai-mintlify-7055a538.mintlify.site/integrations/google-sheets.md): Connect your PolyAI agent to Google Sheets for lookups, logging, and dynamic content.
- [Ideal Postcode](https://polyai-mintlify-7055a538.mintlify.site/integrations/ideal-postcode.md): Enable UK address lookup and validation during calls with Ideal Postcode.
- [DeepL](https://polyai-mintlify-7055a538.mintlify.site/integrations/deepl.md): Enable real-time translation during calls with DeepL integration.
- [Overview](https://polyai-mintlify-7055a538.mintlify.site/releases/overview.md)
- [08.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.08.md): August 2026 release notes.
- [07.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.07.md): July 2026 release notes.
- [06.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.06.md): June 2026 release notes.
- [05.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.05.md): May 2026 release notes.
- [04.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.04.md): April 2026 release notes.
- [03.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.03.md): March 2026 release notes.
- [02.2026](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/26.02.md): February 2026 release notes.
- [12.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.12.md): December 2025 release notes.
- [11.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.11.md): November 2025 release notes.
- [10.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.10.md): October 2025 release notes.
- [09.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.09.md): September 2025 release notes.
- [08.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.08.md): August 2025 release notes.
- [07.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.07.md): July 2025 release notes.
- [06.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.06.md): June 2025 release notes.
- [05.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.05.md): May 2025 release notes.
- [04.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.04.md): April 2025 release notes.
- [03.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.03.md): March 2025 release notes.
- [02.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.02.md): February 2025 release notes.
- [01.2025](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/25.01.md): January 2025 release notes.
- [12.2024](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/24.12.md): December 2024 release notes.
- [11.2024](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/24.11.md): November 2024 release notes.
- [10.2024](https://polyai-mintlify-7055a538.mintlify.site/releases/notes/24.10.md): October 2024 release notes.

## OpenAPI Specs

- [openapi](https://polyai-mintlify-7055a538.mintlify.site/api-reference/webrtc-gateway/openapi.yaml)

## Optional

- [Home](https://docs.poly.ai/home)
- [Community](https://polyaijupiter-uki8686.slack.com/archives/C075ST5UK7Y)
- [Blog](https://poly.ai/resources/?_resource_type=post)