# Vapi

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vapi.ai/_mcp/server

## Docs

- [Introduction](https://docs.vapi.ai/quickstart/introduction.md): Build voice AI agents that can make and receive phone calls
- [Phone calls](https://docs.vapi.ai/quickstart/phone.md): Learn to make your first phone call with a voice agent
- [Web calls](https://docs.vapi.ai/quickstart/web.md): Build voice interfaces and backend integrations using Vapi's Web and Server SDKs
- [Guides](https://docs.vapi.ai/guides.md): Explore real-world, cloneable examples to build voice agents with Assistants and Squads
- [Composer](https://docs.vapi.ai/composer.md): Build and configure voice AI agents through natural conversation
- [Vapi CLI](https://docs.vapi.ai/cli.md): Command-line interface for building voice AI applications faster
- [Assistants quickstart](https://docs.vapi.ai/assistants/quickstart.md): Build your first assistant and make a phone call in minutes
- [Transient vs permanent configurations](https://docs.vapi.ai/assistants/concepts/transient-vs-permanent-configurations.md): Learn to choose between inline and stored assistant configurations
- [Variables](https://docs.vapi.ai/assistants/dynamic-variables.md): Personalize assistant messages with dynamic and default variables
- [Multilingual support](https://docs.vapi.ai/customization/multilingual.md): Configure multilingual voice AI agents with automatic language detection, cross-language conversation, and localized voices
- [Personalization with user information](https://docs.vapi.ai/assistants/personalization.md): Add customer-specific information to your voice assistant conversations
- [Voice formatting plan](https://docs.vapi.ai/assistants/voice-formatting-plan.md): Format LLM output for natural-sounding speech
- [Flush syntax](https://docs.vapi.ai/assistants/flush-syntax.md): Force immediate voice transmission with VAPI's flush syntax for real-time interactions
- [Background messages](https://docs.vapi.ai/assistants/background-messages.md): Silently update chat history with background messages
- [Idle messages](https://docs.vapi.ai/assistants/idle-messages.md): Keep users engaged during conversation pauses
- [Assistant hooks](https://docs.vapi.ai/assistants/assistant-hooks.md): Automate actions on call events and interruptions
- [Call timeout settings](https://docs.vapi.ai/documentation/assistants/conversation-behavior/call-timeout-settings.md): Configure silence and maximum-duration timeouts for assistants, distinguish inactivity from total call duration, and troubleshoot timeout call endings.
- [Keypad input settings](https://docs.vapi.ai/documentation/assistants/conversation-behavior/keypad-input-settings.md): Keypad input settings let assistants collect caller-entered digits. Configure timeouts and delimiters for menus, codes, and account information during calls.
- [End call phrases](https://docs.vapi.ai/documentation/assistants/conversation-behavior/end-call-phrases.md): End call phrases let assistants end calls after saying configured text. Choose reliable phrases and prevent unintended transcript matches during calls.
- [Background speech denoising](https://docs.vapi.ai/documentation/assistants/conversation-behavior/background-speech-denoising.md): Filter out noise and background speech while users are talking
- [Pronunciation dictionaries](https://docs.vapi.ai/assistants/pronunciation-dictionaries.md): Control how your AI assistant pronounces specific words and phrases
- [Email address reading](https://docs.vapi.ai/assistants/email-address-reading.md): Get your voice agent to collect, read back, and confirm email addresses clearly
- [Speech configuration](https://docs.vapi.ai/customization/speech-configuration.md): Control when your assistant starts and stops speaking
- [Voice pipeline configuration](https://docs.vapi.ai/customization/voice-pipeline-configuration.md): Complete guide to configuring VAPI's voice pipeline for optimal conversation timing and interruption handling
- [Voice fallback configuration](https://docs.vapi.ai/voice-fallback-plan.md): Configure fallback voices that activate automatically if your primary voice fails.
- [Transcriber fallback configuration](https://docs.vapi.ai/customization/transcriber-fallback-plan.md): Configure fallback transcribers so calls keep working if your primary speech-to-text provider fails. Covers automatic fallback, manual fallback, and HIPAA-compliant provider options.
- [OpenAI Realtime](https://docs.vapi.ai/openai-realtime.md): Build voice assistants with OpenAI's native speech-to-speech models for ultra-low latency conversations
- [Provider Keys](https://docs.vapi.ai/customization/provider-keys.md): Bring your own API keys to Vapi.
- [Versioning](https://docs.vapi.ai/assistants/versioning.md): Versioning saves published assistant and tool configurations so you can make changes in a draft, review their history, and restore an earlier version.
- [Versioning with assistants](https://docs.vapi.ai/assistants/versioning/versioning-assistants.md): Publish assistant changes, review version history, restore an earlier configuration as a new current version, and select the published assistant version for a call.
- [Versioning with tools](https://docs.vapi.ai/assistants/versioning/versioning-tools.md): Publish tool changes, review version history, restore an earlier configuration to the draft, and select the specific tool version that an assistant uses.
- [How versioning works with assistants and tools](https://docs.vapi.ai/assistants/versioning/versioning-with-assistants-and-tools.md): Select a specific or latest tool version for an assistant, and learn how restoring an assistant also restores the tool version selections saved with it.
- [Model Intelligence for transcribers, models, and voices](https://docs.vapi.ai/assistants/model-intelligence/overview.md): Model Intelligence helps you choose transcribers, models, and voices with curated presets and weekly refreshed performance metrics for latency, cost, and quality.
- [Model Presets for transcribers, models, and voices](https://docs.vapi.ai/assistants/model-intelligence/presets.md): Model presets optimize for balanced performance, reasoning, low latency, or low cost. Learn when to use each preset and how to apply or customize its configuration.
- [Performance metrics and methodology reference](https://docs.vapi.ai/assistants/model-intelligence/metrics-methodology.md): The performance metrics reference explains how Vapi sources and calculates latency, cost, and quality data for each supported transcriber, model, and voice.
- [How voice agent component costs and estimates work](https://docs.vapi.ai/assistants/model-intelligence/understanding-cost.md): Understand how Vapi estimates transcriber, model, and voice costs per minute, including prompt caching assumptions and the effects of conversation history.
- [How voice-to-voice latency works in voice agents](https://docs.vapi.ai/assistants/model-intelligence/understanding-latency.md): Understand voice-to-voice latency, the components included in Vapi performance metrics, and how model capability, endpointing, and transport affect response time.
- [Introduction to Tools](https://docs.vapi.ai/tools.md): Extend your assistant's capabilities with powerful function calling tools.
- [Default Tools](https://docs.vapi.ai/tools/default-tools.md): Adding Transfer Call, End Call, Dial Keypad, and API Request capabilities to your assistants.
- [Voicemail Tool](https://docs.vapi.ai/tools/voicemail-tool.md): Learn how to use the assistant-controlled voicemail tool for flexible voicemail handling
- [Custom Tools](https://docs.vapi.ai/tools/custom-tools.md): Learn how to create and configure Custom Tools for use by your Vapi assistants.
- [Code Tool](https://docs.vapi.ai/tools/code-tool.md): Execute custom TypeScript code directly within your assistant without setting up a server.
- [Client-side Tools (Web SDK)](https://docs.vapi.ai/tools/client-side-websdk.md): Handle tool-calls in the browser without a server URL
- [Tool rejection plan](https://docs.vapi.ai/tools/tool-rejection-plan.md): Prevent unintended tool calls using conditions based on conversation state
- [Static variables and aliases](https://docs.vapi.ai/tools/static-variables-and-aliases.md): Inject server-controlled values into tool calls without LLM involvement, and chain values across tool calls deterministically.
- [Custom tools troubleshooting](https://docs.vapi.ai/tools/custom-tools-troubleshooting.md): Resolve common issues with custom tool integrations
- [Google Calendar Integration](https://docs.vapi.ai/tools/google-calendar.md): Connect your assistant to Google Calendar for seamless appointment scheduling and availability checking.
- [Google Sheets Integration](https://docs.vapi.ai/tools/google-sheets.md): Connect your assistant to Google Sheets for seamless data entry.
- [Slack Integration](https://docs.vapi.ai/tools/slack.md): Connect your assistant to Slack for seamless message sending.
- [GoHighLevel Integration](https://docs.vapi.ai/tools/go-high-level.md): Connect your assistant to GoHighLevel for seamless appointment scheduling, contact creation, and availability checking.
- [Introduction to Knowledge Bases](https://docs.vapi.ai/knowledge-base.md): Learn how to create and integrate custom knowledge bases into your AI assistants.
- [Using the Query Tool for Knowledge Bases](https://docs.vapi.ai/knowledge-base/using-query-tool.md): Learn how to configure and use the query tool to enhance your AI assistants with custom knowledge bases.
- [Custom Knowledge Base](https://docs.vapi.ai/knowledge-base/custom-knowledge-base.md): Create and implement your own knowledge base server for full control over document retrieval
- [Tool Arguments Encryption](https://docs.vapi.ai/tools/encryption.md): Learn to encrypt tool arguments and protect sensitive data
- [Deepgram Keywords and Keyterm Prompting](https://docs.vapi.ai/customization/custom-keywords.md): Boost STT accuracy for domain words and phrases
- [Custom voices](https://docs.vapi.ai/customization/custom-voices/custom-voice.md): Use a custom voice with your preferred provider
- [ElevenLabs](https://docs.vapi.ai/customization/custom-voices/elevenlabs.md): Set up a custom ElevenLabs voice in Vapi
- [PlayHT](https://docs.vapi.ai/customization/custom-voices/playht.md): Set up a custom PlayHT voice in Vapi
- [Cartesia](https://docs.vapi.ai/customization/custom-voices/cartesia.md): Use a custom Cartesia voice in Vapi by connecting your Cartesia API key and selecting your voice.
- [Custom transcriber](https://docs.vapi.ai/customization/custom-transcriber.md): Integrate your own transcription service with Vapi
- [Custom TTS integration](https://docs.vapi.ai/customization/custom-voices/custom-tts.md): Learn to integrate your own text-to-speech system with VAPI
- [Fine-tuned OpenAI models](https://docs.vapi.ai/customization/custom-llm/fine-tuned-openai-models.md): Use Another LLM or Your Own Server
- [Connecting Your Custom LLM to Vapi: A Comprehensive Guide](https://docs.vapi.ai/customization/custom-llm/using-your-server.md)
- [Custom LLM Tool Calling Integration](https://docs.vapi.ai/customization/tool-calling-integration.md)
- [Appointment scheduling assistant](https://docs.vapi.ai/assistants/examples/appointment-scheduling.md): Build a voice AI appointment scheduling assistant with Google Calendar integration, availability checking, and automated confirmations using Vapi Assistants.
- [Lead qualification assistant](https://docs.vapi.ai/assistants/examples/lead-qualification.md): Build a voice AI outbound sales assistant with BANT data capture, CRM integration, objection handling, and automated follow-ups using Vapi Assistants.
- [Inbound customer support](https://docs.vapi.ai/assistants/examples/inbound-support.md): Build a voice AI banking support agent with tools for account lookup, balance and transaction retrieval.
- [Web Snippet](https://docs.vapi.ai/assistants/examples/voice-widget.md): Easily integrate the Vapi Voice Widget into your website for enhanced user interaction.
- [Documentation agent](https://docs.vapi.ai/assistants/examples/docs-agent.md): Build a voice assistant that answers questions about your docs
- [Customer support escalation system](https://docs.vapi.ai/assistants/examples/support-escalation.md): Build a voice AI customer support system with dynamic escalation that routes calls based on customer data, issue type, and real-time agent availability using transfer tools and webhooks.
- [Multilingual support agent](https://docs.vapi.ai/assistants/examples/multilingual-agent.md): Build a multilingual voice AI customer support agent with automatic language detection, native voices, and comprehensive tools for international customer service
- [Creating Free Phone Numbers](https://docs.vapi.ai/free-telephony.md): Creating free phone numbers on the Vapi platform.
- [Inbound SMS](https://docs.vapi.ai/phone-numbers/inbound-sms.md): Let agents auto-start chats from incoming text messages (US only)
- [Import number from Twilio](https://docs.vapi.ai/phone-numbers/import-twilio.md): Import a new or existing number from Twilio
- [Import number from Telnyx](https://docs.vapi.ai/telnyx.md): Import and use your Telnyx numbers with Vapi
- [Import a number from DIDWW](https://docs.vapi.ai/phone-numbers/didww.md): Import a DIDWW phone number into Vapi as a BYO SIP trunk number. Assign the inbound trunk credential and an assistant, then test inbound and outbound calls.
- [SIP introduction](https://docs.vapi.ai/advanced/sip.md): Make SIP calls to your Vapi assistant
- [SIP Trunking](https://docs.vapi.ai/advanced/sip/sip-trunk.md): How to integrate your SIP provider with Vapi
- [SIP networking and firewall configuration](https://docs.vapi.ai/advanced/sip/sip-networking.md): Learn to configure your network to allow SIP signalling and media traffic with Vapi
- [Twilio SIP Integration](https://docs.vapi.ai/advanced/sip/twilio.md): How to integrate Twilio SIP with Vapi
- [Telnyx SIP integration](https://docs.vapi.ai/advanced/sip/telnyx.md): How to integrate SIP Telnyx to Vapi
- [DIDWW SIP integration](https://docs.vapi.ai/advanced/sip/didww.md): Set up DIDWW SIP trunking with Vapi. Create inbound and outbound trunks, allowlist signaling IPs, and configure authenticated SIP REFER call transfers.
- [DIDLogic SIP integration](https://docs.vapi.ai/advanced/sip/didlogic.md): Configure DIDLogic and Vapi for inbound calls, outbound calls, and SIP REFER transfers.
- [Zadarma SIP Integration](https://docs.vapi.ai/advanced/sip/zadarma.md): How to integrate SIP Zadarma to Vapi
- [Plivo SIP Integration](https://docs.vapi.ai/advanced/sip/plivo.md): Learn to connect your Plivo SIP trunk to Vapi for inbound and outbound calls
- [Amazon Chime SDK SIP Integration](https://docs.vapi.ai/advanced/sip/amazon-chime.md): How to integrate Amazon Chime SDK Voice Connector with Vapi
- [Troubleshoot SIP trunk credential errors](https://docs.vapi.ai/advanced/sip/troubleshoot-sip-trunk-credential-errors.md): Learn to resolve gateway creation failures when setting up a BYO SIP trunk
- [Troubleshoot SIP response codes](https://docs.vapi.ai/advanced/sip/troubleshoot-sip-response-codes.md): Diagnose SIP response codes by response class, failure point, and call direction, then check the relevant Vapi, provider, network, or destination configuration.
- [Phone Number Hooks](https://docs.vapi.ai/phone-numbers/phone-number-hooks.md)
- [Phone Calling](https://docs.vapi.ai/phone-calling.md): Learn how to create and configure phone numbers with Vapi
- [Outbound Calling](https://docs.vapi.ai/calls/outbound-calling.md): Learn how to send outbound calls from Vapi.
- [WebSocket Transport](https://docs.vapi.ai/calls/websocket-transport.md): Stream audio directly via WebSockets for real-time, bidirectional communication
- [Live Call Control](https://docs.vapi.ai/calls/call-features.md)
- [Customer Join Timeout](https://docs.vapi.ai/calls/customer-join-timeout.md): Set maximum time for users to join web calls before automatic termination
- [Voicemail Detection](https://docs.vapi.ai/calls/voicemail-detection.md)
- [Call Forwarding](https://docs.vapi.ai/call-forwarding.md)
- [Assistant-based warm transfer](https://docs.vapi.ai/calls/assistant-based-warm-transfer.md): Use AI assistants to facilitate call transfers
- [Dynamic call transfers](https://docs.vapi.ai/calls/call-dynamic-transfers.md): Learn how Vapi's dynamic call transfers work and explore implementation patterns for intelligent call routing.
- [Call Handling with Vapi and Twilio](https://docs.vapi.ai/calls/call-handling-with-vapi-and-twilio.md)
- [Debug call forwarding drops](https://docs.vapi.ai/phone-calling/in-call-control/transfer-calls/debug-forwarding-drops.md): Learn to troubleshoot calls that drop immediately after initiating transfer
- [Call queue management with Twilio](https://docs.vapi.ai/calls/call-queue-management.md): Build a call queue system using Twilio to handle large volumes of calls while respecting Vapi concurrency limits, ensuring no calls are dropped.
- [Understanding Call Concurrency](https://docs.vapi.ai/calls/call-concurrency.md): Learn how concurrency slots work, how to stay within the default limit, and how to raise capacity for larger campaigns.
- [Call ended reasons](https://docs.vapi.ai/calls/call-ended-reason.md): All possible call ended reason codes and what they mean.
- [Troubleshoot call errors](https://docs.vapi.ai/calls/troubleshoot-call-errors.md): Learn to diagnose failed calls based on what the caller experienced.
- [Call analysis](https://docs.vapi.ai/assistants/call-analysis.md): Summarize and evaluate calls automatically
- [Call recording, logging and transcribing](https://docs.vapi.ai/assistants/call-recording.md): Learn how to configure artifact plans to record calls, generate transcripts, and store logs for analysis
- [Retrieve call artifacts](https://docs.vapi.ai/assistants/retrieve-call-artifacts.md): How to download call recordings and logs from Vapi's private storage using your Private API Key and short-lived, authenticated redirect URLs.
- [Outbound campaigns quickstart](https://docs.vapi.ai/outbound-campaigns/quickstart.md): Build a simple personalized outbound campaign that conducts post-service feedback and follow-up calls to improve customer experience
- [Outbound campaigns overview](https://docs.vapi.ai/outbound-campaigns/overview.md): Learn how to efficiently schedule calls, manage recipients, analyze performance metrics, and review detailed call logs and transcripts with Vapi's Outbound Call Campaigns
- [Chat quickstart](https://docs.vapi.ai/chat/quickstart.md): Create a text chat with a Vapi assistant, send messages through the Chat API, continue conversations, pass variables, and integrate with TypeScript apps.
- [Streaming chat](https://docs.vapi.ai/chat/streaming.md): Build a streaming Vapi chat integration with server-sent events, display tokens as they arrive, and maintain context across real-time app conversations.
- [Non-streaming chat](https://docs.vapi.ai/chat/non-streaming.md): Build a non-streaming Vapi chat integration that returns complete responses, maintains conversation context, and supports reliable request-response workflows.
- [OpenAI compatibility](https://docs.vapi.ai/chat/openai-compatibility.md): Use Vapi through OpenAI-compatible chat interfaces, migrate existing integrations, and support streaming, non-streaming, and common JavaScript frameworks.
- [Session management](https://docs.vapi.ai/chat/session-management.md): Manage Vapi chat context with previousChatId or sessionId, understand when to use each method, and build persistent multi-turn conversations safely at scale.
- [Variable substitution in sessions](https://docs.vapi.ai/chat/variable-substitution.md): Use variable substitution in Vapi chat sessions, understand when values are resolved, and choose safe patterns for updating personalized conversation context.
- [SMS chat](https://docs.vapi.ai/chat/sms-chat.md): Connect a 10DLC-approved Twilio number to a Vapi assistant, receive customer-initiated SMS messages, and maintain context through managed chat sessions.
- [Web widget](https://docs.vapi.ai/chat/web-widget.md): Add Vapi's web widget to a website for voice and text conversations, configure its appearance and behavior, and meet pay-as-you-go chat access requirements.
- [Workflows migration guide](https://docs.vapi.ai/workflows/legacy-migration.md): Migrate your Vapi Workflows to Squads before Workflows is retired on August 18, 2026.
- [Workflows quickstart](https://docs.vapi.ai/workflows/quickstart.md): Build a simple agent that greets users and gathers basic information using Vapi workflows.
- [Workflows overview](https://docs.vapi.ai/workflows/overview.md): Learn to create robust, deterministic conversation flows with a visual builder.
- [Appointment scheduling workflow](https://docs.vapi.ai/workflows/examples/appointment-scheduling.md): Build a voice AI appointment scheduling workflow with calendar integration, availability checking, and automated confirmations using Vapi's workflow builder.
- [Lead qualification workflow](https://docs.vapi.ai/workflows/examples/lead-qualification.md): Build a voice AI outbound sales workflow with lead qualification, CRM integration, and automated follow-up using Vapi's visual workflow builder.
- [Clinic triage and scheduling workflow](https://docs.vapi.ai/workflows/examples/clinic-triage-scheduling.md): Build a voice AI clinic workflow with medical triage protocols, appointment booking, and emergency routing using Vapi's visual workflow builder.
- [E-commerce order management workflow](https://docs.vapi.ai/workflows/examples/ecommerce-order-management.md): Build a voice AI e-commerce workflow with order tracking, return processing, and customer support automation using Vapi's visual workflow builder.
- [Property management call routing](https://docs.vapi.ai/workflows/examples/property-management.md): Build a voice AI property management system with dynamic call routing that determines destinations based on tenant verification, inquiry type analysis, and real-time agent availability using workflow API requests.
- [Multilingual support workflow](https://docs.vapi.ai/workflows/examples/multilingual-support.md): Build a multilingual voice AI customer support workflow with language selection, dedicated conversation nodes, and cultural context using Vapi's workflow builder.
- [Configuring Inbound and Outbound Calls for Squads](https://docs.vapi.ai/squads-example.md): Configuring assistants for inbound/outbound calls.
- [Introduction to Squads (Multi-Assistant Conversations)](https://docs.vapi.ai/squads.md): Use Squads to handle complex workflows and tasks.
- [Handoff tool](https://docs.vapi.ai/squads/handoff.md): Transfer the call to another assistant, squad, or dynamically determined destination.
- [Passing data between assistants](https://docs.vapi.ai/squads/passing-data-between-assistants.md): Three approaches for forwarding context to the next assistant in a squad — when to use each, and what each one costs.
- [Clinic triage with handoff tools](https://docs.vapi.ai/squads/examples/clinic-triage-scheduling-handoff-tool.md): Build a multi-assistant clinic experience with specialized assistants for triage, emergency handling, and scheduling using handoff tools.
- [Clinic triage and scheduling squad](https://docs.vapi.ai/squads/examples/clinic-triage-scheduling.md): Build a multi-assistant clinic experience with specialized assistants for triage, emergency handling, and scheduling using Squads.
- [E‑commerce order management squad](https://docs.vapi.ai/squads/examples/ecommerce-order-management.md): Build a multi-assistant experience for order tracking, returns processing, and VIP handling using Squads.
- [Property management routing squad](https://docs.vapi.ai/squads/examples/property-management.md): Build a property management Squad with a router assistant plus maintenance and leasing specialists for accurate transfers.
- [Multilingual support squad](https://docs.vapi.ai/squads/examples/multilingual-support.md): Build a Squad with dedicated English, Spanish, and French assistants and a language selection entrance flow.
- [Silent Handoffs](https://docs.vapi.ai/squads/silent-handoffs.md)
- [Server URLs](https://docs.vapi.ai/server-url.md): Learn how to set up your server to receive and respond to messages from Vapi.
- [Setting server URLs](https://docs.vapi.ai/server-url/setting-server-urls.md): Learn about where you can set server URLs to handle call events.
- [Server events](https://docs.vapi.ai/server-url/events.md): Learn about different events that can be sent to a Server URL.
- [Spam call rejection](https://docs.vapi.ai/server-url/spam-call-rejection.md): Screen inbound calls and reject known spam using your Server URL
- [Developing locally](https://docs.vapi.ai/server-url/developing-locally.md): Learn how to receive server events in your local development environment.
- [Server authentication](https://docs.vapi.ai/server-url/server-authentication.md)
- [Evals quickstart](https://docs.vapi.ai/observability/evals-quickstart.md): Get started with AI agent testing in 5 minutes
- [Advanced eval testing](https://docs.vapi.ai/observability/evals-advanced.md): Master testing strategies and best practices for production AI agents
- [Simulations overview](https://docs.vapi.ai/observability/simulations-overview.md): Simulations test assistants and squads through real conversations with AI testers. Learn how simulations work in Vapi and when to use them instead of Evals.
- [Simulations quickstart](https://docs.vapi.ai/observability/simulations-quickstart.md): Create a simulation suite that asks an AI tester to book an appointment with Riley, then evaluate whether it was booked for the requested date and time.
- [Simulations advanced](https://docs.vapi.ai/observability/simulations-advanced.md): Configure advanced simulations with AI tester settings, variables, tool mocks, lifecycle webhooks, and reusable structured outputs for consistent testing.
- [Manage simulations](https://docs.vapi.ai/observability/simulations-manage.md): Manage Vapi simulation suites and runs: edit configurations, review and rerun results, develop testing strategies, maintain coverage, and delete suites.
- [Boards quickstart](https://docs.vapi.ai/observability/boards-quickstart.md): Create custom analytics dashboards in minutes
- [Structured outputs](https://docs.vapi.ai/assistants/structured-outputs.md): Extract structured, schema-defined data from voice calls using AI-powered analysis. Covers field types, extraction timing, limitations, and HIPAA storage behavior.
- [Structured outputs quickstart](https://docs.vapi.ai/assistants/structured-outputs-quickstart.md): Set up structured data extraction from calls in a few minutes. Create a schema, link it to an assistant, test extraction, and configure HIPAA-safe storage settings.
- [Structured outputs examples](https://docs.vapi.ai/assistants/structured-outputs-examples.md): Real-world examples and templates for common use cases
- [Scorecard quickstart](https://docs.vapi.ai/observability/scorecard-quickstart.md): Automatically grade calls against KPIs using structured outputs
- [Monitoring quickstart](https://docs.vapi.ai/observability/monitoring-quickstart.md): Set up automated quality monitoring for your voice AI agents
- [Voice AI Prompting Guide](https://docs.vapi.ai/prompting-guide.md): How to write effective prompts for voice AI assistants
- [Debugging voice agents](https://docs.vapi.ai/debugging.md): Learn to identify, diagnose, and fix common issues with your voice assistants and workflows
- [Enterprise environments (DEV/UAT/PROD)](https://docs.vapi.ai/documentation/best-practices/enterprise-environments-dev-uat-prod.md): Promotion and configuration management for assistants and squads
- [IVR Navigation](https://docs.vapi.ai/ivr-navigation.md): How to navigate IVR menu systems effectively
- [Test Suites](https://docs.vapi.ai/test/test-suites.md): End-to-end test automation for AI voice agents
- [Chat Testing](https://docs.vapi.ai/test/chat-testing.md): Automated text-based testing for AI agents
- [Voice Testing](https://docs.vapi.ai/test/voice-testing.md): Automated voice call testing for AI voice agents
- [Frequently Asked Questions](https://docs.vapi.ai/faq.md): Frequently asked questions about Vapi.
- [Manage pay-as-you-go billing and credits](https://docs.vapi.ai/billing/manage-billing-and-credits.md): Manage pay-as-you-go billing in the Vapi Dashboard: add a payment method, buy credits, configure auto reload, and download PDF statements and invoices.
- [Core Models](https://docs.vapi.ai/quickstart.md): Learn about the three core components to Vapi's voice AI pipeline.
- [Integrations](https://docs.vapi.ai/providers/integrations.md): Integrations let you connect your own provider accounts to Vapi. Learn what an integration is, when you need one, and how to add provider credentials in the dashboard.
- [Voices (Text-to-speech)](https://docs.vapi.ai/providers/voice/overview.md): Find, preview, and use text-to-speech voices from any Vapi-supported provider, and look up a voiceId in the Vapi dashboard.
- [Vapi Voices](https://docs.vapi.ai/providers/voice/vapi-voices.md): Browse Vapi's curated voices, preview voice samples, review language support, and configure a Vapi voice on an assistant.
- [Legacy voice migration guide](https://docs.vapi.ai/providers/voice/vapi-voices/legacy-migration.md): Legacy Vapi Voices were retired on March 1, 2026. Here's what changed and how to update if needed.
- [Azure](https://docs.vapi.ai/providers/voice/azure.md): Configure Azure Speech as your Vapi assistant's text-to-speech provider and select an Azure voice.
- [Cartesia](https://docs.vapi.ai/providers/voice/cartesia.md): Configure Cartesia as your Vapi assistant's text-to-speech provider, including supported languages and voice options.
- [Deepgram](https://docs.vapi.ai/providers/voice/deepgram.md): Configure Deepgram as your Vapi assistant's text-to-speech provider and select a Deepgram Aura voice.
- [ElevenLabs](https://docs.vapi.ai/providers/voice/elevenlabs.md): Configure ElevenLabs as your Vapi assistant's text-to-speech provider and select an ElevenLabs voice.
- [Hume](https://docs.vapi.ai/providers/voice/hume.md): Connect Hume to Vapi to use its expressive Octave text-to-speech voices for your voice agent. Covers the models and how to select a voice in the API.
- [Inworld](https://docs.vapi.ai/providers/voice/inworld.md): Configure an Inworld voice for a Vapi assistant and find its voice ID in the Vapi Voice Library.
- [LMNT](https://docs.vapi.ai/providers/voice/imnt.md): Configure an LMNT voice for a Vapi assistant and find its voice ID in the Vapi Voice Library.
- [Microsoft](https://docs.vapi.ai/providers/voice/microsoft.md): Connect Microsoft to Vapi to use its MAI-Voice-2 text-to-speech voices for your voice agent. Covers how to select a Microsoft voice in the API.
- [MiniMax](https://docs.vapi.ai/providers/voice/minimax.md): Configure MiniMax as your Vapi assistant's text-to-speech provider, including voice models, voice IDs, and subtitle timing.
- [Neuphonic](https://docs.vapi.ai/providers/voice/neuphonic.md): Connect Neuphonic to Vapi to use its text-to-speech voices for your voice agent. Covers how to select a Neuphonic voice in the API.
- [OpenAI](https://docs.vapi.ai/providers/voice/openai.md): Configure OpenAI as your Vapi assistant's text-to-speech provider, including TTS models and voice selection.
- [PlayHT](https://docs.vapi.ai/providers/voice/playht.md): Configure a PlayHT voice for a Vapi assistant and find its voice ID in the Vapi Voice Library.
- [Rime AI](https://docs.vapi.ai/providers/voice/rimeai.md): Configure a Rime AI model and voice for a Vapi assistant and find its voice ID in the Vapi Voice Library.
- [Sesame](https://docs.vapi.ai/providers/voice/sesame.md): Connect Sesame to Vapi to use its conversational text-to-speech voices for your voice agent. Covers the model, the available voices, and how to select one in the API.
- [Smallest AI](https://docs.vapi.ai/providers/voice/smallest-ai.md): Connect Smallest AI to Vapi to use its low-latency text-to-speech voices for your voice agent. Covers the model and how to select a voice in the API.
- [WellSaid](https://docs.vapi.ai/providers/voice/wellsaid.md): Connect WellSaid Labs to Vapi to use its studio-quality text-to-speech voices for your voice agent. Covers the models and how to select a voice in the API.
- [xAI](https://docs.vapi.ai/providers/voice/xai.md): Configure xAI as your Vapi assistant's text-to-speech provider, including supported voices, languages, and voice options.
- [Model providers](https://docs.vapi.ai/providers/model/overview.md): Reference of every large language model provider Vapi supports, including provider IDs, HIPAA, GDPR, and PCI coverage, and where to configure each one.
- [Anthropic](https://docs.vapi.ai/providers/model/anthropic.md): Connect Anthropic to Vapi to use Claude models as your voice agent's language model. Covers the supported Claude models and how to use them in the API.
- [Anthropic Bedrock](https://docs.vapi.ai/providers/model/anthropic-bedrock.md): Connect AWS Bedrock credentials to Vapi and use Anthropic Claude models with your AWS account, regions, rate limits, and data controls.
- [Anyscale](https://docs.vapi.ai/providers/model/anyscale.md): Connect Anyscale to Vapi to use an OpenAI-compatible endpoint as your voice agent's language model. Covers how to specify the model in the API.
- [Azure OpenAI](https://docs.vapi.ai/providers/model/azure-openai.md): Connect an Azure OpenAI resource to Vapi. Configure credentials, deployment names, supported models, regions, and endpoints.
- [Cerebras](https://docs.vapi.ai/providers/model/cerebras.md): Connect Cerebras credentials to Vapi for use with supported integrations.
- [DeepInfra](https://docs.vapi.ai/providers/model/deepinfra.md): Connect DeepInfra to Vapi and configure a model served by your DeepInfra account as your assistant's language model.
- [DeepSeek](https://docs.vapi.ai/providers/model/deepseek.md): Connect DeepSeek credentials to Vapi for use with supported integrations.
- [Google](https://docs.vapi.ai/providers/model/gemini.md): Configure Google Gemini as your Vapi assistant's language model and choose from the models Vapi supports.
- [Groq](https://docs.vapi.ai/providers/model/groq.md): Connect Groq to Vapi, choose a supported model, and configure it as your assistant's language model.
- [Inflection AI](https://docs.vapi.ai/providers/model/inflection-ai.md): Connect Inflection AI credentials to Vapi for use with supported integrations.
- [MiniMax](https://docs.vapi.ai/providers/model/minimax.md): Configure MiniMax as your Vapi assistant's language model and choose from the models Vapi supports.
- [Mistral](https://docs.vapi.ai/providers/model/mistral.md): Connect Mistral to Vapi to use Mistral Large and Mistral Small as your voice agent's language model. Configure it in the dashboard.
- [OpenAI](https://docs.vapi.ai/providers/model/openai.md): Configure OpenAI as your Vapi assistant's language model and choose from the GPT models Vapi supports.
- [OpenRouter](https://docs.vapi.ai/providers/model/openrouter.md): Connect OpenRouter to Vapi and use a text-generation model ID from OpenRouter's current model catalog.
- [Perplexity](https://docs.vapi.ai/providers/model/perplexity.md): Connect Perplexity to Vapi and configure a model served by your Perplexity account as your assistant's language model.
- [Together AI](https://docs.vapi.ai/providers/model/togetherai.md): Connect Together AI to Vapi and configure a model served by your Together AI account as your assistant's language model.
- [xAI](https://docs.vapi.ai/providers/model/xai.md): Configure xAI as your Vapi assistant's language model and choose from the Grok models Vapi supports.
- [Transcribers (Speech-to-text)](https://docs.vapi.ai/providers/transcriber/overview.md): Reference of every speech-to-text provider Vapi supports, including provider IDs, HIPAA and GDPR (EU) coverage, and where to configure each one.
- [AssemblyAI](https://docs.vapi.ai/providers/transcriber/assembly-ai.md): Configure AssemblyAI Universal-Streaming as your Vapi assistant's transcriber through the dashboard or API.
- [Azure](https://docs.vapi.ai/providers/transcriber/azure.md): Configure Azure Speech as your Vapi assistant's transcriber and select from the languages Vapi supports.
- [Cartesia](https://docs.vapi.ai/providers/transcriber/cartesia.md): Configure Cartesia as your Vapi assistant's transcriber, including supported languages and transcription options.
- [Deepgram](https://docs.vapi.ai/providers/transcriber/deepgram.md): Configure Deepgram as your Vapi assistant's transcriber, including supported models and languages.
- [ElevenLabs](https://docs.vapi.ai/providers/transcriber/elevenlabs.md): Configure ElevenLabs as your Vapi assistant's transcriber, including Scribe models and supported languages.
- [Gladia](https://docs.vapi.ai/providers/transcriber/gladia.md): Configure a Gladia transcription model, language, and provider settings for a Vapi assistant.
- [Google](https://docs.vapi.ai/providers/transcriber/google.md): Configure Google as your Vapi assistant's transcriber, including Gemini transcription models and supported languages.
- [OpenAI](https://docs.vapi.ai/providers/transcriber/openai.md): Configure OpenAI as your Vapi assistant's transcriber, including transcription models and supported languages.
- [Soniox](https://docs.vapi.ai/providers/transcriber/soniox.md): Connect Soniox to a Vapi assistant and configure the stt-rt-v5 real-time speech-to-text model for low-latency, multilingual transcription and endpointing.
- [Speechmatics](https://docs.vapi.ai/providers/transcriber/speechmatics.md): Configure Speechmatics as your Vapi assistant's transcriber and review setup guidance and supported options.
- [Talkscriber](https://docs.vapi.ai/providers/transcriber/talkscriber.md): Use Talkscriber with Vapi for real-time Whisper transcription. See configuration fields, defaults, supported languages, and an API example.
- [xAI](https://docs.vapi.ai/providers/transcriber/xai.md): Configure xAI as your Vapi assistant's transcriber, including supported models, languages, and transcription options.
- [AWS S3](https://docs.vapi.ai/providers/cloud/s3.md): Store recordings of chat conversations in AWS S3
- [GCP Cloud Storage](https://docs.vapi.ai/providers/cloud/gcp.md): Store recordings of chat conversations in GCP Cloud Storage
- [Cloudflare R2](https://docs.vapi.ai/providers/cloud/cloudflare.md): Store recordings of chat conversations in Cloudflare R2
- [Supabase S3 Storage](https://docs.vapi.ai/providers/cloud/supabase.md): Store recordings of chat conversations in Supabase Storage
- [Langfuse Integration with Vapi](https://docs.vapi.ai/providers/observability/langfuse.md): Integrate Vapi with Langfuse for enhanced voice AI telemetry monitoring, enabling improved performance and reliability of your AI applications.
- [Voiceflow](https://docs.vapi.ai/providers/voiceflow.md): Vapi x Voiceflow
- [ChatDash Integration with Vapi](https://docs.vapi.ai/providers/chat-dash.md): ChatDash is a white-label dashboard platform that integrates with Vapi to provide analytics, call logs, and Stripe billing for AI agent agencies.
- [Vapify Integration with Vapi](https://docs.vapi.ai/providers/vapify.md): Vapify is a white-label dashboard for Vapi. It helps you turn your agency into a voice AI powerhouse—without writing a single line of code.
- [Voicerr AI - Whitelabel AI Voice Agents](https://docs.vapi.ai/providers/voicerr-ai.md): Voicerr AI is a Vapi-powered voice platform that lets agencies brand dashboards, automate billing, launch campaigns, and run full call-center operations at unlimited scale.
- [VoiceAIWrapper Integration with Vapi](https://docs.vapi.ai/providers/voiceaiwrapper.md): White-Label Vapi Integration | Launch Your Voice AI Agency in 30 Minutes
- [Sympana Connector](https://docs.vapi.ai/providers/sympana-connector.md): Native GoHighLevel automation for Vapi agents
- [Support](https://docs.vapi.ai/support.md): We are open to all kinds of help inquiry, feedback and feature request, help inquiry.
- [How to Report Issues Effectively](https://docs.vapi.ai/issue-reporting.md): Learn how to structure your issue reports for fast and accurate resolution
- [Vapi Enterprise](https://docs.vapi.ai/enterprise/plans.md): Build and scale with Vapi.
- [Definitions](https://docs.vapi.ai/glossary.md): Useful terms and definitions for Vapi & voice AI applications.
- [RSS Feed](https://docs.vapi.ai/rss-feed.md): Stay updated with the latest incidents from Vapi or third party providers
- [Data Flow](https://docs.vapi.ai/security-and-privacy/data-flow.md): How data flows through Vapi's voice pipeline. What's processed in real time, what's stored by default, and how custom storage or custom model servers change where data lives.
- [API keys](https://docs.vapi.ai/security-and-privacy/api-keys.md): API keys authenticate requests to Vapi. Learn where to find public and private keys, choose the correct type, restrict access, and store each key securely.
- [Single Sign-On (SSO)](https://docs.vapi.ai/security-and-privacy/sso.md): Let your team access Vapi through your identity provider using SAML or OIDC.
- [JWT Authentication](https://docs.vapi.ai/customization/jwt-authentication.md): Secure API authentication guide
- [Recording consent plan](https://docs.vapi.ai/security-and-privacy/recording-consent-plan.md): Learn how to configure recording consent plans to ensure compliance with privacy laws and regulations
- [GDPR Compliance](https://docs.vapi.ai/security-and-privacy/GDPR.md): Learn how Vapi ensures GDPR compliance for its voice assistant platform.
- [HIPAA Compliance](https://docs.vapi.ai/security-and-privacy/hipaa.md): HIPAA on Vapi. Enable organization-wide compliance mode, use approved LLM, voice, and transcriber providers, and control how call recordings and logs are stored.
- [Zero Data Retention (ZDR)](https://docs.vapi.ai/security-and-privacy/zero-data-retention.md): Zero Data Retention (ZDR) is a Vapi organization add-on that stops Vapi from storing call recordings, transcripts, messages, summaries, and logs after a call ends.
- [PCI Compliance](https://docs.vapi.ai/security-and-privacy/pci.md): Ensure secure payment data handling while using Vapi’s voice assistant platform.
- [Proxy server guide](https://docs.vapi.ai/security-and-privacy/proxy-server.md): Keep assistant configs and API keys on your backend. Route Web SDK calls through your proxy.
- [Static IP addresses](https://docs.vapi.ai/security-and-privacy/static-ip-addresses.md): Whitelist Vapi IP addresses
- [TCPA Consent Guide](https://docs.vapi.ai/tcpa-consent.md): Understanding consent requirements for outbound calls using Vapi's voice agent service.
- [Model Context Protocol (MCP) Integration](https://docs.vapi.ai/tools/mcp.md): Connect your assistant to dynamic tools through MCP servers for enhanced capabilities.
- [Vapi MCP Server](https://docs.vapi.ai/sdk/mcp-server.md): Connect Vapi to AI assistants with Model Context Protocol (MCP)
- [Ecosystem](https://docs.vapi.ai/resources.md): Find all of our resources here.
- [Project integration](https://docs.vapi.ai/cli/init.md): Initialize Vapi in your existing projects with intelligent auto-detection
- [MCP integration](https://docs.vapi.ai/cli/mcp.md): Turn your IDE into a Vapi expert with Model Context Protocol
- [Local webhook testing](https://docs.vapi.ai/cli/webhook.md): Forward webhooks to your local development server with vapi listen
- [Authentication management](https://docs.vapi.ai/cli/auth.md): Manage multiple Vapi accounts and environments with the CLI
- [What's New?](https://docs.vapi.ai/whats-new.md)
- [What's New? (all entries)](https://docs.vapi.ai/whats-new/llms.txt)

## API Docs

- API reference > Assistants [List Assistants](https://docs.vapi.ai/api-reference/assistants/list.md)
- API reference > Assistants [Create Assistant](https://docs.vapi.ai/api-reference/assistants/create.md)
- API reference > Assistants [Get Assistant](https://docs.vapi.ai/api-reference/assistants/get.md)
- API reference > Assistants [Delete Assistant](https://docs.vapi.ai/api-reference/assistants/delete.md)
- API reference > Assistants [Update Assistant](https://docs.vapi.ai/api-reference/assistants/update.md)
- API reference > Squads [List Squads](https://docs.vapi.ai/api-reference/squads/list.md)
- API reference > Squads [Create Squad](https://docs.vapi.ai/api-reference/squads/create.md)
- API reference > Squads [Get Squad](https://docs.vapi.ai/api-reference/squads/get.md)
- API reference > Squads [Delete Squad](https://docs.vapi.ai/api-reference/squads/delete.md)
- API reference > Squads [Update Squad](https://docs.vapi.ai/api-reference/squads/update.md)
- API reference > Calls [List Calls](https://docs.vapi.ai/api-reference/calls/list.md)
- API reference > Calls [Create Call](https://docs.vapi.ai/api-reference/calls/create.md)
- API reference > Calls [Get Call](https://docs.vapi.ai/api-reference/calls/get.md)
- API reference > Calls [Delete Call](https://docs.vapi.ai/api-reference/calls/delete.md)
- API reference > Calls [Update Call](https://docs.vapi.ai/api-reference/calls/update.md)
- API reference > Calls [Download Call Mono Recording](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-mono-recording-download.md)
- API reference > Calls [Download Call Stereo Recording](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-stereo-recording-download.md)
- API reference > Calls [Download Call Video Recording](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-video-recording-download.md)
- API reference > Calls [Download Call Customer Recording](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-customer-recording-download.md)
- API reference > Calls [Download Call Assistant Recording](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-assistant-recording-download.md)
- API reference > Calls [Download Call Packet Capture (pcap)](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-pcap-download.md)
- API reference > Calls [Download Call Logs](https://docs.vapi.ai/api-reference/calls/call-artifact-controller-call-logs-download.md)
- API reference > Chats [List Chats](https://docs.vapi.ai/api-reference/chats/list.md)
- API reference > Chats [Create Chat](https://docs.vapi.ai/api-reference/chats/create.md)
- API reference > Chats [Get Chat](https://docs.vapi.ai/api-reference/chats/get.md)
- API reference > Chats [Delete Chat](https://docs.vapi.ai/api-reference/chats/delete.md)
- API reference > Chats [Create Chat (OpenAI Compatible)](https://docs.vapi.ai/api-reference/chats/create-response.md)
- API reference > Campaigns [List Campaigns](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-find-all.md)
- API reference > Campaigns [Create Campaign](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-create.md)
- API reference > Campaigns [List Campaigns V2](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-find-all-v-2.md)
- API reference > Campaigns [Create Campaign V2](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-create-v-2.md)
- API reference > Campaigns [Get Campaign V2](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-find-one-v-2.md)
- API reference > Campaigns [Delete Campaign](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-remove-v-2.md)
- API reference > Campaigns [Update Campaign](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-update-v-2.md)
- API reference > Campaigns [Get Campaign](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-find-one.md)
- API reference > Campaigns [Get Campaign V2 Contacts](https://docs.vapi.ai/api-reference/campaigns/campaign-controller-get-campaign-v-2-contacts.md)
- API reference > Sessions [List Sessions](https://docs.vapi.ai/api-reference/sessions/list.md)
- API reference > Sessions [Create Session](https://docs.vapi.ai/api-reference/sessions/create.md)
- API reference > Sessions [Get Session](https://docs.vapi.ai/api-reference/sessions/get.md)
- API reference > Sessions [Delete Session](https://docs.vapi.ai/api-reference/sessions/delete.md)
- API reference > Sessions [Update Session](https://docs.vapi.ai/api-reference/sessions/update.md)
- API reference > Phone Numbers [List Phone Numbers](https://docs.vapi.ai/api-reference/phone-numbers/list.md)
- API reference > Phone Numbers [Create Phone Number](https://docs.vapi.ai/api-reference/phone-numbers/create.md)
- API reference > Phone Numbers [Get Phone Number](https://docs.vapi.ai/api-reference/phone-numbers/get.md)
- API reference > Phone Numbers [Delete Phone Number](https://docs.vapi.ai/api-reference/phone-numbers/delete.md)
- API reference > Phone Numbers [Update Phone Number](https://docs.vapi.ai/api-reference/phone-numbers/update.md)
- API reference > Tools [List Tools](https://docs.vapi.ai/api-reference/tools/list.md)
- API reference > Tools [Create Tool](https://docs.vapi.ai/api-reference/tools/create.md)
- API reference > Tools [Get Tool](https://docs.vapi.ai/api-reference/tools/get.md)
- API reference > Tools [Delete Tool](https://docs.vapi.ai/api-reference/tools/delete.md)
- API reference > Tools [Update Tool](https://docs.vapi.ai/api-reference/tools/update.md)
- API reference > Files [List Files](https://docs.vapi.ai/api-reference/files/list.md)
- API reference > Files [Upload File](https://docs.vapi.ai/api-reference/files/create.md)
- API reference > Files [Get File](https://docs.vapi.ai/api-reference/files/get.md)
- API reference > Files [Delete File](https://docs.vapi.ai/api-reference/files/delete.md)
- API reference > Files [Update File](https://docs.vapi.ai/api-reference/files/update.md)
- API reference > Structured Outputs [List Structured Outputs](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-find-all.md)
- API reference > Structured Outputs [Create Structured Output](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-create.md)
- API reference > Structured Outputs [Get Structured Output](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-find-one.md)
- API reference > Structured Outputs [Delete Structured Output](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-remove.md)
- API reference > Structured Outputs [Update Structured Output](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-update.md)
- API reference > Structured Outputs [Run Structured Output](https://docs.vapi.ai/api-reference/structured-outputs/structured-output-controller-run.md)
- API reference > Simulation Personalities [List Personalities](https://docs.vapi.ai/api-reference/simulation-personalities/personality-controller-find-all.md)
- API reference > Simulation Personalities [Create Personality](https://docs.vapi.ai/api-reference/simulation-personalities/personality-controller-create.md)
- API reference > Simulation Personalities [Get Personality](https://docs.vapi.ai/api-reference/simulation-personalities/personality-controller-find-one.md)
- API reference > Simulation Personalities [Delete Personality](https://docs.vapi.ai/api-reference/simulation-personalities/personality-controller-remove.md)
- API reference > Simulation Personalities [Update Personality](https://docs.vapi.ai/api-reference/simulation-personalities/personality-controller-update.md)
- API reference > Simulation Scenarios [List Scenarios](https://docs.vapi.ai/api-reference/simulation-scenarios/scenario-controller-find-all.md)
- API reference > Simulation Scenarios [Create Scenario](https://docs.vapi.ai/api-reference/simulation-scenarios/scenario-controller-create.md)
- API reference > Simulation Scenarios [Get Scenario](https://docs.vapi.ai/api-reference/simulation-scenarios/scenario-controller-find-one.md)
- API reference > Simulation Scenarios [Delete Scenario](https://docs.vapi.ai/api-reference/simulation-scenarios/scenario-controller-remove.md)
- API reference > Simulation Scenarios [Update Scenario](https://docs.vapi.ai/api-reference/simulation-scenarios/scenario-controller-update.md)
- API reference > Simulation Runs [List Simulation Runs](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-find-all.md)
- API reference > Simulation Runs [Create Simulation Run](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-create.md)
- API reference > Simulation Runs [Get Simulation Run](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-find-one.md)
- API reference > Simulation Runs [Cancel Simulation Run](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-cancel-group.md)
- API reference > Simulation Runs [List Simulation Run Items](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-find-items.md)
- API reference > Simulation Runs [Get Simulation Run Item](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-find-item.md)
- API reference > Simulation Runs [Cancel Simulation Run Item](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-cancel-item.md)
- API reference > Simulation Runs [Generate Improvement Suggestions](https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-generate-suggestions.md)
- API reference > Simulation Suites [List Simulation Suites](https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-find-all.md)
- API reference > Simulation Suites [Create Simulation Suite](https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-create.md)
- API reference > Simulation Suites [Get Simulation Suite](https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-find-one.md)
- API reference > Simulation Suites [Delete Simulation Suite](https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-remove.md)
- API reference > Simulation Suites [Update Simulation Suite](https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-update.md)
- API reference > Simulations [Generate Scenarios with AI](https://docs.vapi.ai/api-reference/simulations/simulation-generate-controller-generate.md)
- API reference > Simulations [List Simulations](https://docs.vapi.ai/api-reference/simulations/simulation-controller-find-all.md)
- API reference > Simulations [Create Simulation](https://docs.vapi.ai/api-reference/simulations/simulation-controller-create.md)
- API reference > Simulations [Get Simulation](https://docs.vapi.ai/api-reference/simulations/simulation-controller-find-one.md)
- API reference > Simulations [Delete Simulation](https://docs.vapi.ai/api-reference/simulations/simulation-controller-remove.md)
- API reference > Simulations [Update Simulation](https://docs.vapi.ai/api-reference/simulations/simulation-controller-update.md)
- API reference > Simulations [Get Simulation Concurrency](https://docs.vapi.ai/api-reference/simulations/simulation-controller-get-concurrency.md)
- API reference > Insight [Get Insights](https://docs.vapi.ai/api-reference/insight/insight-controller-find-all.md)
- API reference > Insight [Create Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-create.md)
- API reference > Insight [Get Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-find-one.md)
- API reference > Insight [Delete Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-remove.md)
- API reference > Insight [Update Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-update.md)
- API reference > Insight [Run Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-run.md)
- API reference > Insight [Preview Insight](https://docs.vapi.ai/api-reference/insight/insight-controller-preview.md)
- API reference > Board [Get Boards](https://docs.vapi.ai/api-reference/board/board-controller-find-all.md)
- API reference > Board [Create Board](https://docs.vapi.ai/api-reference/board/board-controller-create.md)
- API reference > Board [Get Default Metrics Overview Board](https://docs.vapi.ai/api-reference/board/board-controller-metrics-overview-ensure.md)
- API reference > Board [Get Board](https://docs.vapi.ai/api-reference/board/board-controller-find-one.md)
- API reference > Board [Delete Board](https://docs.vapi.ai/api-reference/board/board-controller-remove.md)
- API reference > Board [Update Board](https://docs.vapi.ai/api-reference/board/board-controller-update.md)
- API reference > Eval [List Evals](https://docs.vapi.ai/api-reference/eval/eval-controller-get-paginated.md)
- API reference > Eval [Create Eval](https://docs.vapi.ai/api-reference/eval/eval-controller-create.md)
- API reference > Eval [Get Eval](https://docs.vapi.ai/api-reference/eval/eval-controller-get.md)
- API reference > Eval [Delete Eval](https://docs.vapi.ai/api-reference/eval/eval-controller-remove.md)
- API reference > Eval [Update Eval](https://docs.vapi.ai/api-reference/eval/eval-controller-update.md)
- API reference > Eval [Get Eval Run](https://docs.vapi.ai/api-reference/eval/eval-controller-get-run.md)
- API reference > Eval [Delete Eval Run](https://docs.vapi.ai/api-reference/eval/eval-controller-remove-run.md)
- API reference > Eval [List Eval Runs](https://docs.vapi.ai/api-reference/eval/eval-controller-get-runs-paginated.md)
- API reference > Eval [Create Eval Run](https://docs.vapi.ai/api-reference/eval/eval-controller-run.md)
- API reference > Observability Scorecard [Get Scorecard](https://docs.vapi.ai/api-reference/observability-scorecard/scorecard-controller-get.md)
- API reference > Observability Scorecard [Delete Scorecard](https://docs.vapi.ai/api-reference/observability-scorecard/scorecard-controller-remove.md)
- API reference > Observability Scorecard [Update Scorecard](https://docs.vapi.ai/api-reference/observability-scorecard/scorecard-controller-update.md)
- API reference > Observability Scorecard [List Scorecards](https://docs.vapi.ai/api-reference/observability-scorecard/scorecard-controller-get-paginated.md)
- API reference > Observability Scorecard [Create Scorecard](https://docs.vapi.ai/api-reference/observability-scorecard/scorecard-controller-create.md)
- API reference > Provider Resources [List Provider Resources](https://docs.vapi.ai/api-reference/provider-resources/provider-resource-controller-get-provider-resources-paginated.md)
- API reference > Provider Resources [Create Provider Resource](https://docs.vapi.ai/api-reference/provider-resources/provider-resource-controller-create-provider-resource.md)
- API reference > Provider Resources [Get Provider Resource](https://docs.vapi.ai/api-reference/provider-resources/provider-resource-controller-get-provider-resource.md)
- API reference > Provider Resources [Delete Provider Resource](https://docs.vapi.ai/api-reference/provider-resources/provider-resource-controller-delete-provider-resource.md)
- API reference > Provider Resources [Update Provider Resource](https://docs.vapi.ai/api-reference/provider-resources/provider-resource-controller-update-provider-resource.md)
- API reference > Analytics [Create Analytics Queries](https://docs.vapi.ai/api-reference/analytics/get.md)
- Webhooks [Server Message](https://docs.vapi.ai/api-reference/webhooks/server-message.md)
- Webhooks [Client Message](https://docs.vapi.ai/api-reference/webhooks/client-message.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.vapi.ai/openapi.json)
- [OpenAPI YAML](https://docs.vapi.ai/openapi.yaml)