diff --git a/fern/advanced/sip/sip-chime.mdx b/fern/advanced/sip/sip-chime.mdx index 1526c7841..1b7b5b06e 100644 --- a/fern/advanced/sip/sip-chime.mdx +++ b/fern/advanced/sip/sip-chime.mdx @@ -2,6 +2,7 @@ title: Amazon Chime SDK SIP Integration subtitle: How to integrate Amazon Chime SDK Voice Connector with Vapi slug: advanced/sip/amazon-chime +description: Integrate Amazon Chime SDK Voice Connector with Vapi for inbound and outbound SIP trunking, connecting an AI assistant to a phone number without Lambda logic. --- This guide walks you through setting up both outbound and inbound SIP trunking between Amazon Chime SDK and Vapi using a Voice Connector. diff --git a/fern/advanced/sip/sip-networking.mdx b/fern/advanced/sip/sip-networking.mdx index e70088476..1700b3a64 100644 --- a/fern/advanced/sip/sip-networking.mdx +++ b/fern/advanced/sip/sip-networking.mdx @@ -2,6 +2,7 @@ title: SIP networking and firewall configuration subtitle: Learn to configure your network to allow SIP signalling and media traffic with Vapi slug: advanced/sip/sip-networking +description: Configure your firewall and network for Vapi SIP trunks, with the IP addresses, ports, and protocols needed to allow SIP signaling and RTP media traffic. --- ## Overview diff --git a/fern/advanced/sip/sip-plivo.mdx b/fern/advanced/sip/sip-plivo.mdx index 14d0cbacb..54156b145 100644 --- a/fern/advanced/sip/sip-plivo.mdx +++ b/fern/advanced/sip/sip-plivo.mdx @@ -2,6 +2,7 @@ title: Plivo SIP Integration subtitle: Learn to connect your Plivo SIP trunk to Vapi for inbound and outbound calls slug: advanced/sip/plivo +description: Connect a Plivo SIP trunk to your Vapi agents for inbound and outbound calls, covering trunk setup and routing between Plivo and Vapi. --- ## Overview diff --git a/fern/advanced/sip/sip-telnyx.mdx b/fern/advanced/sip/sip-telnyx.mdx index 96d60713b..700c2ddd9 100644 --- a/fern/advanced/sip/sip-telnyx.mdx +++ b/fern/advanced/sip/sip-telnyx.mdx @@ -2,6 +2,7 @@ title: Telnyx SIP integration subtitle: How to integrate SIP Telnyx to Vapi slug: advanced/sip/telnyx +description: Connect a Telnyx SIP trunk to Vapi for inbound and outbound calls, walking through the full setup so your AI voice assistants can handle calls. --- Integrate your Telnyx SIP trunk with Vapi to enable your AI voice assistants to handle calls efficiently. This guide walks you through the complete setup process for both inbound and outbound calls. diff --git a/fern/advanced/sip/sip-trunk.mdx b/fern/advanced/sip/sip-trunk.mdx index 1cd023ea0..204aa1cb6 100644 --- a/fern/advanced/sip/sip-trunk.mdx +++ b/fern/advanced/sip/sip-trunk.mdx @@ -2,6 +2,7 @@ title: SIP Trunking subtitle: How to integrate your SIP provider with Vapi slug: advanced/sip/sip-trunk +description: Integrate your SIP provider with Vapi using SIP trunking, connecting your PBX or VoIP system to the PSTN with the network and allowlist requirements. --- SIP trunking replaces traditional phone lines with a virtual connection over the internet, allowing your business to make and receive calls via a broadband connection. It connects your internal PBX or VoIP system to a SIP provider, which then routes calls to the Public Switched Telephone Network (PSTN). This setup simplifies your communications infrastructure and often reduces costs. diff --git a/fern/advanced/sip/sip-twilio.mdx b/fern/advanced/sip/sip-twilio.mdx index 741afd1d6..5d3d7cb89 100644 --- a/fern/advanced/sip/sip-twilio.mdx +++ b/fern/advanced/sip/sip-twilio.mdx @@ -2,6 +2,7 @@ title: Twilio SIP Integration subtitle: How to integrate Twilio SIP with Vapi slug: advanced/sip/twilio +description: Connect a Twilio SIP trunk to Vapi for inbound and outbound calls, walking through the setup so your AI voice assistants can handle Twilio calls. --- diff --git a/fern/advanced/sip/sip-zadarma.mdx b/fern/advanced/sip/sip-zadarma.mdx index 481203919..1511fa02b 100644 --- a/fern/advanced/sip/sip-zadarma.mdx +++ b/fern/advanced/sip/sip-zadarma.mdx @@ -2,6 +2,7 @@ title: Zadarma SIP Integration subtitle: How to integrate SIP Zadarma to Vapi slug: advanced/sip/zadarma +description: Connect a Zadarma SIP trunk to Vapi for inbound and outbound calls, walking through the setup so your AI voice assistants can handle Zadarma calls. --- diff --git a/fern/advanced/sip/sip.mdx b/fern/advanced/sip/sip.mdx index 9ddd8419a..402fd2570 100644 --- a/fern/advanced/sip/sip.mdx +++ b/fern/advanced/sip/sip.mdx @@ -2,6 +2,7 @@ title: SIP introduction subtitle: Make SIP calls to your Vapi assistant slug: advanced/sip +description: Make and test SIP calls to a Vapi assistant from any SIP client or softphone, assigning a SIP phone number and passing template variables through SIP headers. --- ## Overview diff --git a/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx b/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx index 4447932a9..d1e54afd1 100644 --- a/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx +++ b/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx @@ -2,6 +2,7 @@ title: "Troubleshoot SIP trunk credential errors" subtitle: "Learn to resolve gateway creation failures when setting up a BYO SIP trunk" slug: advanced/sip/troubleshoot-sip-trunk-credential-errors +description: Resolve the SIP gateway creation failed error when creating a BYO SIP trunk credential in Vapi, covering the common causes and how to fix each one. --- ## Overview diff --git a/fern/assistants/assistant-hooks.mdx b/fern/assistants/assistant-hooks.mdx index 7657f2e3c..e6af5c35f 100644 --- a/fern/assistants/assistant-hooks.mdx +++ b/fern/assistants/assistant-hooks.mdx @@ -2,6 +2,7 @@ title: Assistant hooks subtitle: Automate actions on call events and interruptions slug: assistants/assistant-hooks +description: Automate actions on Vapi call events like ending and speech interruptions, using assistant hooks to transfer calls, run functions, or send messages. --- ## Overview diff --git a/fern/assistants/background-messages.mdx b/fern/assistants/background-messages.mdx index 385773705..488b9c8ea 100644 --- a/fern/assistants/background-messages.mdx +++ b/fern/assistants/background-messages.mdx @@ -2,6 +2,7 @@ title: Background messages subtitle: Silently update chat history with background messages slug: assistants/background-messages +description: Silently add information to a Vapi call's chat history without notifying the user, logging button presses, actions, or context updates during the conversation. --- ## Overview diff --git a/fern/assistants/call-analysis.mdx b/fern/assistants/call-analysis.mdx index 347470146..359354f99 100644 --- a/fern/assistants/call-analysis.mdx +++ b/fern/assistants/call-analysis.mdx @@ -2,6 +2,7 @@ title: Call analysis subtitle: Summarize and evaluate calls automatically slug: assistants/call-analysis +description: Automatically summarize and evaluate every Vapi call after it ends, using an LLM to generate summaries, extract structured data, and score calls for quality. --- ## Overview diff --git a/fern/assistants/concepts/transient-vs-permanent-configurations.mdx b/fern/assistants/concepts/transient-vs-permanent-configurations.mdx index 0697d1733..89ae902bf 100644 --- a/fern/assistants/concepts/transient-vs-permanent-configurations.mdx +++ b/fern/assistants/concepts/transient-vs-permanent-configurations.mdx @@ -2,6 +2,7 @@ title: "Transient vs permanent configurations" subtitle: "Learn to choose between inline and stored assistant configurations" slug: assistants/concepts/transient-vs-permanent-configurations +description: Choose between transient inline and permanent stored assistant configurations in Vapi, and learn when each fits for flexibility, reusability, and management. --- ## Overview diff --git a/fern/assistants/dynamic-variables.mdx b/fern/assistants/dynamic-variables.mdx index b785885b1..959cdd9b7 100644 --- a/fern/assistants/dynamic-variables.mdx +++ b/fern/assistants/dynamic-variables.mdx @@ -2,6 +2,7 @@ title: Variables subtitle: Personalize assistant messages with dynamic and default variables slug: assistants/dynamic-variables +description: Personalize Vapi assistant prompts and messages with dynamic variables in double curly braces, setting values at call time through assistantOverrides. --- ## Overview diff --git a/fern/assistants/email-address-reading.mdx b/fern/assistants/email-address-reading.mdx index c0a9d0571..00516b991 100644 --- a/fern/assistants/email-address-reading.mdx +++ b/fern/assistants/email-address-reading.mdx @@ -2,6 +2,7 @@ title: Email address reading subtitle: Get your voice agent to collect, read back, and confirm email addresses clearly slug: assistants/email-address-reading +description: Get a Vapi voice agent to collect, read back, and confirm email addresses clearly, using built-in TTS formatting, prompting, and confirmation techniques. --- ## Overview diff --git a/fern/assistants/examples/docs-agent.mdx b/fern/assistants/examples/docs-agent.mdx index 50bc9de79..3189849f2 100644 --- a/fern/assistants/examples/docs-agent.mdx +++ b/fern/assistants/examples/docs-agent.mdx @@ -2,6 +2,7 @@ title: Documentation agent subtitle: Build a voice assistant that answers questions about your docs slug: assistants/examples/docs-agent +description: Build a Vapi voice assistant that answers questions about your documentation, step by step, using the Dashboard or the API to configure and deploy it. --- Try our live implementation using the voice widget in the bottom-right corner of this page. diff --git a/fern/assistants/examples/voice-widget.mdx b/fern/assistants/examples/voice-widget.mdx index 98f61202e..5cc837b25 100644 --- a/fern/assistants/examples/voice-widget.mdx +++ b/fern/assistants/examples/voice-widget.mdx @@ -4,6 +4,7 @@ subtitle: >- Easily integrate the Vapi Voice Widget into your website for enhanced user interaction. slug: assistants/examples/voice-widget +description: Add the Vapi Voice Widget to your website so visitors can talk to a voice assistant, using a copy-paste snippet or a custom implementation. --- Improve your website's user interaction with the Vapi Voice Widget. This robust tool enables your visitors to engage with a voice assistant for support and interaction, offering a smooth and contemporary way to connect with your services. diff --git a/fern/assistants/idle-messages.mdx b/fern/assistants/idle-messages.mdx index 8aa41ee8a..ef08fc171 100644 --- a/fern/assistants/idle-messages.mdx +++ b/fern/assistants/idle-messages.mdx @@ -2,6 +2,7 @@ title: Idle messages subtitle: Keep users engaged during conversation pauses slug: assistants/idle-messages +description: Keep users engaged during Vapi call pauses with idle messages that trigger on customer silence, using fixed text or model-generated prompts via assistant hooks. --- ## Overview diff --git a/fern/assistants/personalization.mdx b/fern/assistants/personalization.mdx index 44dde42ad..bd95c1a5b 100644 --- a/fern/assistants/personalization.mdx +++ b/fern/assistants/personalization.mdx @@ -2,6 +2,7 @@ title: Personalization with user information subtitle: Add customer-specific information to your voice assistant conversations slug: assistants/personalization +description: Personalize Vapi conversations with customer-specific data your server supplies at call time, tailoring responses for support, account management, and more. --- ## Overview diff --git a/fern/assistants/pronunciation-dictionaries.mdx b/fern/assistants/pronunciation-dictionaries.mdx index 3c2f7d361..2f3a1e6c6 100644 --- a/fern/assistants/pronunciation-dictionaries.mdx +++ b/fern/assistants/pronunciation-dictionaries.mdx @@ -2,6 +2,7 @@ title: Pronunciation dictionaries subtitle: Control how your AI assistant pronounces specific words and phrases slug: assistants/pronunciation-dictionaries +description: Control how a Vapi assistant pronounces specific words, names, and acronyms using pronunciation dictionaries with phoneme and alias rules by voice provider. --- ## Overview diff --git a/fern/assistants/quickstart.mdx b/fern/assistants/quickstart.mdx index f7f35262b..e218b6ded 100644 --- a/fern/assistants/quickstart.mdx +++ b/fern/assistants/quickstart.mdx @@ -2,6 +2,7 @@ title: Assistants quickstart subtitle: Build your first assistant and make a phone call in minutes slug: assistants/quickstart +description: Build your first Vapi assistant, connect it to a phone number, and make a call, working through the steps in the Dashboard or with the Vapi API. --- ## Overview diff --git a/fern/assistants/structured-outputs-examples.mdx b/fern/assistants/structured-outputs-examples.mdx index 36472a2f5..95b606223 100644 --- a/fern/assistants/structured-outputs-examples.mdx +++ b/fern/assistants/structured-outputs-examples.mdx @@ -2,6 +2,7 @@ title: Structured outputs examples subtitle: Real-world examples and templates for common use cases slug: assistants/structured-outputs-examples +description: Production-ready structured outputs examples for Vapi, with complete schemas, configuration, and integration code for common business scenarios. --- ## Overview diff --git a/fern/assistants/voice-formatting-plan.mdx b/fern/assistants/voice-formatting-plan.mdx index f9080d550..e23504211 100644 --- a/fern/assistants/voice-formatting-plan.mdx +++ b/fern/assistants/voice-formatting-plan.mdx @@ -2,6 +2,7 @@ title: Voice formatting plan subtitle: Format LLM output for natural-sounding speech slug: assistants/voice-formatting-plan +description: Format Vapi LLM output for natural-sounding speech, expanding numbers, currency, and symbols so text-to-speech reads them clearly, enabled by default. --- ## Overview diff --git a/fern/calls/call-ended-reason.mdx b/fern/calls/call-ended-reason.mdx index 69acb687e..0fc9d301a 100644 --- a/fern/calls/call-ended-reason.mdx +++ b/fern/calls/call-ended-reason.mdx @@ -2,6 +2,7 @@ title: Call ended reasons subtitle: All possible call ended reason codes and what they mean. slug: calls/call-ended-reason +description: Understand Vapi endedReason codes that explain why a call ended, where to find them in call logs and the Call object, and how to diagnose each one. --- Every call in Vapi ends with an `endedReason` code that tells you exactly why it ended. You can find this value in the **"Ended Reason"** column of your [call logs](https://dashboard.vapi.ai/calls), or under the `endedReason` field on the [Call object](/api-reference/calls/get). diff --git a/fern/calls/call-features.mdx b/fern/calls/call-features.mdx index c24e6dc5e..ea3e30e3b 100644 --- a/fern/calls/call-features.mdx +++ b/fern/calls/call-features.mdx @@ -1,6 +1,7 @@ --- title: Live Call Control slug: calls/call-features +description: Control live Vapi calls in real time with Call Control to inject conversation elements and Call Listen to stream call audio over a WebSocket connection. --- Vapi offers two main features that provide enhanced control over live calls: diff --git a/fern/calls/call-handling-with-vapi-and-twilio.mdx b/fern/calls/call-handling-with-vapi-and-twilio.mdx index 275ff8dc2..eb48f40a9 100644 --- a/fern/calls/call-handling-with-vapi-and-twilio.mdx +++ b/fern/calls/call-handling-with-vapi-and-twilio.mdx @@ -1,6 +1,7 @@ --- title: Call Handling with Vapi and Twilio slug: calls/call-handling-with-vapi-and-twilio +description: Keep a caller on hold while dialing a specialist using Vapi and Twilio, with a fallback action when the specialist misses the call or it reaches voicemail. --- This document explains how to handle a scenario where a user is on hold while the system attempts to connect them to a specialist. If the specialist does not pick up within X seconds or if the call hits voicemail, we take an alternate action (like playing an announcement or scheduling an appointment). This solution integrates Vapi.ai for AI-driven conversations and Twilio for call bridging. diff --git a/fern/calls/call-outbound.mdx b/fern/calls/call-outbound.mdx index beec06add..ab378bda1 100644 --- a/fern/calls/call-outbound.mdx +++ b/fern/calls/call-outbound.mdx @@ -2,6 +2,7 @@ title: Outbound Calling subtitle: Learn how to send outbound calls from Vapi. slug: calls/outbound-calling +description: Send outbound calls from Vapi programmatically, placing single or batch calls and scheduling them for reminders, surveys, and automated call campaigns. --- ## Introduction to Outbound Calling diff --git a/fern/calls/troubleshoot-call-errors.mdx b/fern/calls/troubleshoot-call-errors.mdx index bdbba3efd..7a479ce1b 100644 --- a/fern/calls/troubleshoot-call-errors.mdx +++ b/fern/calls/troubleshoot-call-errors.mdx @@ -2,6 +2,7 @@ title: Troubleshoot call errors subtitle: Learn to diagnose failed calls based on what the caller experienced. slug: calls/troubleshoot-call-errors +description: Diagnose failed Vapi calls by what the caller experienced, with errors organized by symptom so you can jump to the right fix for each call failure. --- ## Overview diff --git a/fern/calls/troubleshoot-call-forwarding-drops.mdx b/fern/calls/troubleshoot-call-forwarding-drops.mdx index c0c606f38..a3f02263e 100644 --- a/fern/calls/troubleshoot-call-forwarding-drops.mdx +++ b/fern/calls/troubleshoot-call-forwarding-drops.mdx @@ -1,6 +1,7 @@ --- title: "Debug call forwarding drops" subtitle: "Learn to troubleshoot calls that drop immediately after initiating transfer" +description: Troubleshoot Vapi calls that drop immediately after a transfer, finding why forwarding disconnects both parties and how to resolve the underlying cause. --- ## Overview diff --git a/fern/calls/voicemail-detection.mdx b/fern/calls/voicemail-detection.mdx index cf0be793e..7b4e803f2 100644 --- a/fern/calls/voicemail-detection.mdx +++ b/fern/calls/voicemail-detection.mdx @@ -1,6 +1,7 @@ --- title: Voicemail Detection slug: calls/voicemail-detection +description: Detect voicemail on outbound Vapi calls to handle it faster and more flexibly, keeping your voice agents efficient when a call reaches an answering machine. --- When you're running outbound voice agents, voicemails are a reality — but wasting time or missing opportunities because of them shouldn't be. diff --git a/fern/composer.mdx b/fern/composer.mdx index 5b7105d5c..ca7892586 100644 --- a/fern/composer.mdx +++ b/fern/composer.mdx @@ -2,6 +2,7 @@ title: Composer subtitle: Build and configure voice AI agents through natural conversation slug: composer +description: Build and configure Vapi voice agents through natural conversation with Composer, which creates assistants, sets up numbers and integrations, and troubleshoots. --- diff --git a/fern/customization/custom-keywords.mdx b/fern/customization/custom-keywords.mdx index 0fb5e0a0f..0fba8a479 100644 --- a/fern/customization/custom-keywords.mdx +++ b/fern/customization/custom-keywords.mdx @@ -2,6 +2,7 @@ title: Keywords and keyterm prompting subtitle: Boost STT accuracy for domain words and phrases slug: customization/custom-keywords +description: Boost Vapi transcription accuracy for domain terms and proper nouns using Deepgram keyword boosting and AssemblyAI keyterm prompting on your assistant. --- diff --git a/fern/customization/custom-llm/fine-tuned-openai-models.mdx b/fern/customization/custom-llm/fine-tuned-openai-models.mdx index a93991302..15358bf4a 100644 --- a/fern/customization/custom-llm/fine-tuned-openai-models.mdx +++ b/fern/customization/custom-llm/fine-tuned-openai-models.mdx @@ -2,6 +2,7 @@ title: Fine-tuned OpenAI models subtitle: Use Another LLM or Your Own Server slug: customization/custom-llm/fine-tuned-openai-models +description: Use fine-tuned or OpenAI-compatible models as your Vapi LLM, connecting endpoints like OpenRouter, Together AI, or your own server to power an assistant. --- diff --git a/fern/customization/custom-llm/tool-calling-integration.mdx b/fern/customization/custom-llm/tool-calling-integration.mdx index 252343feb..a8285bfd1 100644 --- a/fern/customization/custom-llm/tool-calling-integration.mdx +++ b/fern/customization/custom-llm/tool-calling-integration.mdx @@ -1,6 +1,7 @@ --- title: Custom LLM Tool Calling Integration slug: customization/tool-calling-integration +description: Add tool calling to a custom LLM in Vapi so your model can trigger external functions and actions mid-conversation, with the request and response format. --- ## What Is a Custom LLM and Why Use It? diff --git a/fern/customization/custom-llm/using-your-server.mdx b/fern/customization/custom-llm/using-your-server.mdx index 65e25a5cf..5f9f4e227 100644 --- a/fern/customization/custom-llm/using-your-server.mdx +++ b/fern/customization/custom-llm/using-your-server.mdx @@ -1,6 +1,7 @@ --- title: 'Connecting Your Custom LLM to Vapi: A Comprehensive Guide' slug: customization/custom-llm/using-your-server +description: Connect your own server as a custom LLM in Vapi, walking through an OpenAI-compatible setup with Ngrok to handle the request and response flow end to end. --- diff --git a/fern/customization/custom-transcriber.mdx b/fern/customization/custom-transcriber.mdx index 36162c8d3..1b1109512 100644 --- a/fern/customization/custom-transcriber.mdx +++ b/fern/customization/custom-transcriber.mdx @@ -2,6 +2,7 @@ title: Custom transcriber subtitle: Integrate your own transcription service with Vapi slug: customization/custom-transcriber +description: Integrate your own transcription service with Vapi instead of a built-in provider, using a custom transcriber, shown here with a Deepgram setup. --- ## Overview diff --git a/fern/customization/custom-tts.mdx b/fern/customization/custom-tts.mdx index fc7903ad0..b2ef0b6c1 100644 --- a/fern/customization/custom-tts.mdx +++ b/fern/customization/custom-tts.mdx @@ -2,6 +2,7 @@ title: Custom TTS integration subtitle: Learn to integrate your own text-to-speech system with VAPI slug: customization/custom-voices/custom-tts +description: Integrate your own text-to-speech system with Vapi for full control over voice synthesis, using any TTS provider while keeping real-time performance. --- ## Overview diff --git a/fern/customization/custom-voices/custom-voice.mdx b/fern/customization/custom-voices/custom-voice.mdx index 7b9e91510..e403ee5bb 100644 --- a/fern/customization/custom-voices/custom-voice.mdx +++ b/fern/customization/custom-voices/custom-voice.mdx @@ -2,6 +2,7 @@ title: Custom voices subtitle: Use a custom voice with your preferred provider slug: customization/custom-voices/custom-voice +description: Use a custom voice from any supported provider in Vapi by setting the voice property in your assistant configuration with the provider's voice details. --- You can use your own custom voice with any supported provider by setting the `voice` property in your assistant configuration: diff --git a/fern/customization/custom-voices/elevenlabs.mdx b/fern/customization/custom-voices/elevenlabs.mdx index 664e5e994..f755d8a14 100644 --- a/fern/customization/custom-voices/elevenlabs.mdx +++ b/fern/customization/custom-voices/elevenlabs.mdx @@ -2,6 +2,7 @@ title: ElevenLabs subtitle: Set up a custom ElevenLabs voice in Vapi slug: customization/custom-voices/elevenlabs +description: Set up a custom or cloned ElevenLabs voice in Vapi, subscribing to an ElevenLabs API plan and adding your API key and voice ID to your assistant. --- This guide outlines the procedure for integrating your cloned voice with ElevenLabs through the Vapi platform. diff --git a/fern/customization/custom-voices/playht.mdx b/fern/customization/custom-voices/playht.mdx index 2dd2ba3d0..2d9cbeefb 100644 --- a/fern/customization/custom-voices/playht.mdx +++ b/fern/customization/custom-voices/playht.mdx @@ -2,6 +2,7 @@ title: PlayHT subtitle: Set up a custom PlayHT voice in Vapi slug: customization/custom-voices/playht +description: Set up a custom PlayHT voice in Vapi, subscribing to a PlayHT API plan and adding your credentials and voice details to your assistant configuration. --- You can use your own custom PlayHT voice with Vapi by following these steps. diff --git a/fern/customization/jwt-authentication.mdx b/fern/customization/jwt-authentication.mdx index 3535854d6..4c1fe0d25 100644 --- a/fern/customization/jwt-authentication.mdx +++ b/fern/customization/jwt-authentication.mdx @@ -2,6 +2,7 @@ title: JWT Authentication subtitle: Secure API authentication guide slug: customization/jwt-authentication +description: Authenticate Vapi API requests securely with JWT, covering how to generate a JSON Web Token and use it to authorize your calls to the API. --- This documentation provides an overview of JWT (JSON Web Token) Authentication and demonstrates how to generate a JWT token and use it to authenticate API requests securely. diff --git a/fern/customization/speech-configuration.mdx b/fern/customization/speech-configuration.mdx index 3f8f4c8e7..0dcce4e62 100644 --- a/fern/customization/speech-configuration.mdx +++ b/fern/customization/speech-configuration.mdx @@ -2,6 +2,7 @@ title: Speech configuration subtitle: Control when your assistant starts and stops speaking slug: customization/speech-configuration +description: Control when a Vapi assistant starts and stops speaking, tuning speech settings to sound natural, avoid interrupting the customer, and reduce awkward pauses. --- ## Overview diff --git a/fern/debugging.mdx b/fern/debugging.mdx index 3fdc5dabe..bb4c32315 100644 --- a/fern/debugging.mdx +++ b/fern/debugging.mdx @@ -2,6 +2,7 @@ title: Debugging voice agents subtitle: Learn to identify, diagnose, and fix common issues with your voice assistants slug: debugging +description: Diagnose and fix voice agent issues using the Vapi dashboard's Call Logs, API Logs, and webhook logs, component testing, and provider status checks. --- ## Overview diff --git a/fern/enterprise/dev-uat-prod.mdx b/fern/enterprise/dev-uat-prod.mdx index 8cf7e7be7..171d4cb7d 100644 --- a/fern/enterprise/dev-uat-prod.mdx +++ b/fern/enterprise/dev-uat-prod.mdx @@ -1,6 +1,7 @@ --- title: Enterprise environments (DEV/UAT/PROD) subtitle: Promotion and configuration management for assistants and squads +description: Promote and manage Vapi assistant and squad configurations across DEV, UAT, and PROD environments, giving enterprise teams a repeatable, auditable workflow. --- ## Purpose diff --git a/fern/enterprise/plans.mdx b/fern/enterprise/plans.mdx index 675fe1cdd..b689ae75b 100644 --- a/fern/enterprise/plans.mdx +++ b/fern/enterprise/plans.mdx @@ -2,6 +2,7 @@ title: Vapi Enterprise subtitle: Build and scale with Vapi. slug: enterprise/plans +description: Explore Vapi Enterprise plans for production voice AI, which can include unlimited concurrency, higher rate limits, reserved capacity, and hands-on support. --- If you're building a production application on Vapi, we can help you every step of the way from idea to full-scale deployment. diff --git a/fern/faq.mdx b/fern/faq.mdx index b90cd5ae4..c81caf222 100644 --- a/fern/faq.mdx +++ b/fern/faq.mdx @@ -2,6 +2,7 @@ title: Frequently Asked Questions subtitle: Frequently asked questions about Vapi. slug: faq +description: Answers to common questions about Vapi, covering use-case fit, latency, pricing at volume, concurrency, compliance, security, and deployment options. --- diff --git a/fern/glossary.mdx b/fern/glossary.mdx index 1ed239a6f..8231eb9b4 100644 --- a/fern/glossary.mdx +++ b/fern/glossary.mdx @@ -2,6 +2,7 @@ title: Definitions subtitle: Useful terms and definitions for Vapi & voice AI applications. slug: glossary +description: Definitions of key voice AI and Vapi terms, from transcription, LLM, and TTS to backchanneling, endpointing, and other concepts used across the docs. --- diff --git a/fern/guides.mdx b/fern/guides.mdx index e9615f6a2..5e4f55d85 100644 --- a/fern/guides.mdx +++ b/fern/guides.mdx @@ -2,6 +2,7 @@ title: Guides subtitle: Explore real-world, cloneable examples to build voice agents with Assistants and Squads slug: guides +description: Browse real-world, cloneable Vapi examples that build voice agents with assistants and squads, from appointment booking to multilingual support routing. --- diff --git a/fern/issue-reporting.mdx b/fern/issue-reporting.mdx index 5863df5a2..8ee6be94f 100644 --- a/fern/issue-reporting.mdx +++ b/fern/issue-reporting.mdx @@ -3,6 +3,7 @@ title: How to Report Issues Effectively subtitle: >- Learn how to structure your issue reports for fast and accurate resolution slug: issue-reporting +description: Report Vapi issues effectively by including the right call IDs, timestamps, and reproduction details so support can diagnose and resolve them faster. --- To help us assist you as quickly and accurately as possible, it's essential to provide specific and actionable details when reporting issues. Vague messages like "X is not working" slow down the resolution process. diff --git a/fern/ivr-navigation.mdx b/fern/ivr-navigation.mdx index 38667ea31..550813c01 100644 --- a/fern/ivr-navigation.mdx +++ b/fern/ivr-navigation.mdx @@ -2,6 +2,7 @@ title: IVR Navigation subtitle: How to navigate IVR menu systems effectively slug: ivr-navigation +description: Navigate IVR phone menus reliably with Vapi's DTMF tool, using digit pauses, provider-specific pause characters, and prompting tips for accurate input. --- ## Overview diff --git a/fern/knowledge-base/custom-knowledge-base.mdx b/fern/knowledge-base/custom-knowledge-base.mdx index c6049d754..bc08dd5ac 100644 --- a/fern/knowledge-base/custom-knowledge-base.mdx +++ b/fern/knowledge-base/custom-knowledge-base.mdx @@ -2,6 +2,7 @@ title: Custom Knowledge Base subtitle: Create and implement your own knowledge base server for full control over document retrieval slug: knowledge-base/custom-knowledge-base +description: Build a custom knowledge base in Vapi with your own retrieval server, using your vector database or search logic to control how an assistant finds answers. --- ## Overview diff --git a/fern/knowledge-base/knowledge-base.mdx b/fern/knowledge-base/knowledge-base.mdx index 43e85ada4..554315458 100644 --- a/fern/knowledge-base/knowledge-base.mdx +++ b/fern/knowledge-base/knowledge-base.mdx @@ -4,6 +4,7 @@ subtitle: >- Learn how to create and integrate custom knowledge bases into your AI assistants. slug: knowledge-base +description: Create and integrate knowledge bases into Vapi voice agents so they retrieve information from your documents to answer questions accurately during a call. --- diff --git a/fern/knowledge-base/using-query-tool.mdx b/fern/knowledge-base/using-query-tool.mdx index 78907d463..a305ba368 100644 --- a/fern/knowledge-base/using-query-tool.mdx +++ b/fern/knowledge-base/using-query-tool.mdx @@ -3,6 +3,7 @@ title: Using the Query Tool for Knowledge Bases subtitle: >- Learn how to configure and use the query tool to enhance your AI assistants with custom knowledge bases. slug: knowledge-base/using-query-tool +description: Configure the Vapi query tool to give an assistant access to a knowledge base, retrieving information from your files by ID for accurate, grounded responses. --- ## **What is the Query Tool?** diff --git a/fern/observability/boards-quickstart.mdx b/fern/observability/boards-quickstart.mdx index a3d642638..08b37c685 100644 --- a/fern/observability/boards-quickstart.mdx +++ b/fern/observability/boards-quickstart.mdx @@ -2,6 +2,7 @@ title: Boards quickstart subtitle: Create custom analytics dashboards in minutes slug: observability/boards-quickstart +description: Build a custom analytics dashboard with Vapi Boards, adding charts, time-range filters, and calculated metrics in the Dashboard to track call performance. --- ## Overview diff --git a/fern/observability/evals-advanced.mdx b/fern/observability/evals-advanced.mdx index ce7eadbd8..a4d8b0769 100644 --- a/fern/observability/evals-advanced.mdx +++ b/fern/observability/evals-advanced.mdx @@ -2,6 +2,7 @@ title: Advanced eval testing subtitle: Master testing strategies and best practices for production AI agents slug: observability/evals-advanced +description: Advanced Vapi Evals strategies for production voice agents, covering smoke, regression, and edge-case tests, performance tuning, and CI/CD integration. --- ## Overview diff --git a/fern/observability/evals-quickstart.mdx b/fern/observability/evals-quickstart.mdx index 2ad8cf07c..3055bce6e 100644 --- a/fern/observability/evals-quickstart.mdx +++ b/fern/observability/evals-quickstart.mdx @@ -2,6 +2,7 @@ title: Evals quickstart subtitle: Get started with AI agent testing in 5 minutes slug: observability/evals-quickstart +description: Set up automated Vapi Evals to test assistants and squads with mock conversations, response validation, tool-call checks, and pass/fail results. --- ## Overview diff --git a/fern/observability/monitoring-quickstart.mdx b/fern/observability/monitoring-quickstart.mdx index 68d4b1bdb..e400ebfd4 100644 --- a/fern/observability/monitoring-quickstart.mdx +++ b/fern/observability/monitoring-quickstart.mdx @@ -2,6 +2,7 @@ title: Monitoring quickstart subtitle: Set up automated quality monitoring for your voice AI agents slug: observability/monitoring-quickstart +description: Create Vapi monitors that evaluate call data against thresholds, open issues when quality drops, and alert your team by email, Slack, or webhook. --- ## Overview diff --git a/fern/observability/scorecard-quickstart.mdx b/fern/observability/scorecard-quickstart.mdx index b72ff67d8..65f20efaa 100644 --- a/fern/observability/scorecard-quickstart.mdx +++ b/fern/observability/scorecard-quickstart.mdx @@ -2,6 +2,7 @@ title: Scorecard quickstart subtitle: Automatically grade calls against KPIs using structured outputs slug: observability/scorecard-quickstart +description: Create a Vapi scorecard that grades completed calls from their structured outputs, awarding points per metric and filtering calls by score via the API. --- ## Overview diff --git a/fern/openai-realtime.mdx b/fern/openai-realtime.mdx index 258e7a8b1..3fcea428c 100644 --- a/fern/openai-realtime.mdx +++ b/fern/openai-realtime.mdx @@ -2,6 +2,7 @@ title: OpenAI Realtime subtitle: Build voice assistants with OpenAI's native speech-to-speech models for ultra-low latency conversations slug: openai-realtime +description: Build Vapi voice assistants on OpenAI's Realtime speech-to-speech models for low latency, covering model choice, configuration, and production best practices. --- ## Overview diff --git a/fern/phone-calling.mdx b/fern/phone-calling.mdx index 9f4c27f6f..880bb4a2d 100644 --- a/fern/phone-calling.mdx +++ b/fern/phone-calling.mdx @@ -2,6 +2,7 @@ title: Phone Calling subtitle: Learn how to create and configure phone numbers with Vapi slug: phone-calling +description: Create and configure phone numbers in Vapi to place and receive calls, using free US numbers or imported Twilio numbers for international and custom use. --- ## Overview diff --git a/fern/phone-numbers/free-telephony.mdx b/fern/phone-numbers/free-telephony.mdx index 1775d6e19..31a53f23b 100644 --- a/fern/phone-numbers/free-telephony.mdx +++ b/fern/phone-numbers/free-telephony.mdx @@ -2,6 +2,7 @@ title: Creating Free Phone Numbers subtitle: Creating free phone numbers on the Vapi platform. slug: free-telephony +description: Create free US phone numbers on Vapi for your assistants or squads, with your first number available before you add a payment method to your account. --- This guide details how to create free phone numbers on the Vapi platform, which you can use with your assistants or squads. diff --git a/fern/phone-numbers/import-twilio.mdx b/fern/phone-numbers/import-twilio.mdx index fb3028f9c..5d03e2c04 100644 --- a/fern/phone-numbers/import-twilio.mdx +++ b/fern/phone-numbers/import-twilio.mdx @@ -2,6 +2,7 @@ title: Import number from Twilio subtitle: Import a new or existing number from Twilio slug: phone-numbers/import-twilio +description: Import a new or existing Twilio phone number into Vapi so your assistants can place and receive calls on it as you scale to other telephony providers. --- ## Overview diff --git a/fern/phone-numbers/inbound-sms.mdx b/fern/phone-numbers/inbound-sms.mdx index ba0610d82..8e7c1d1d3 100644 --- a/fern/phone-numbers/inbound-sms.mdx +++ b/fern/phone-numbers/inbound-sms.mdx @@ -2,6 +2,7 @@ title: Inbound SMS subtitle: Let agents auto-start chats from incoming text messages (US only) slug: phone-numbers/inbound-sms +description: Let Vapi agents auto-start a conversation from an incoming text message, supported for Twilio US numbers with SMS enabled on US-to-US messaging only. --- ## Overview diff --git a/fern/phone-numbers/phone-number-hooks.mdx b/fern/phone-numbers/phone-number-hooks.mdx index eedda78d6..bc775e8c1 100644 --- a/fern/phone-numbers/phone-number-hooks.mdx +++ b/fern/phone-numbers/phone-number-hooks.mdx @@ -1,6 +1,7 @@ --- title: Phone Number Hooks slug: phone-numbers/phone-number-hooks +description: Configure phone number hooks in Vapi to run actions on call events, currently the call.ringing event, by defining them in a phone number's hooks array. --- ## Overview diff --git a/fern/phone-numbers/telnyx.mdx b/fern/phone-numbers/telnyx.mdx index ba25ad577..743376d4a 100644 --- a/fern/phone-numbers/telnyx.mdx +++ b/fern/phone-numbers/telnyx.mdx @@ -2,6 +2,7 @@ title: Import number from Telnyx subtitle: Import and use your Telnyx numbers with Vapi slug: telnyx +description: Import your existing Telnyx phone numbers into Vapi and enable outbound calling, so your assistants or squads can place calls on your Telnyx numbers. --- ## Overview diff --git a/fern/prompting-guide.mdx b/fern/prompting-guide.mdx index 726135898..80a9f6535 100644 --- a/fern/prompting-guide.mdx +++ b/fern/prompting-guide.mdx @@ -2,6 +2,7 @@ title: Voice AI Prompting Guide subtitle: How to write effective prompts for voice AI assistants slug: prompting-guide +description: Write effective prompts for Vapi voice AI assistants, with strategies to design, test, and refine prompts that improve reliability and task success. --- ## Overview diff --git a/fern/providers/chat-dash.mdx b/fern/providers/chat-dash.mdx index 54e36f27e..193ae47cd 100644 --- a/fern/providers/chat-dash.mdx +++ b/fern/providers/chat-dash.mdx @@ -2,6 +2,7 @@ title: ChatDash Integration with Vapi subtitle: ChatDash is a white-label dashboard platform that integrates with Vapi to provide analytics, call logs, and Stripe billing for AI agent agencies. slug: providers/chat-dash +description: Integrate ChatDash with Vapi to give AI agent agencies a white-label dashboard with analytics, call logs, and Stripe billing using your Agent ID and API key. --- [ChatDash](https://bit.ly/3NJpkM7) is a white-label client dashboard platform designed for AI agent agencies. Our seamless integration with Vapi is engineered for simplicity—just enter your Vapi Agent ID and [Vapi API key](/security-and-privacy/api-keys), and your dashboard is up instantly with real-time analytics, detailed call logs, and comprehensive Stripe billing integration. diff --git a/fern/providers/cloud/cloudflare.mdx b/fern/providers/cloud/cloudflare.mdx index c83f82e21..0a368346c 100644 --- a/fern/providers/cloud/cloudflare.mdx +++ b/fern/providers/cloud/cloudflare.mdx @@ -2,6 +2,7 @@ title: Cloudflare R2 subtitle: Store recordings of chat conversations in Cloudflare R2 slug: providers/cloud/cloudflare +description: Store Vapi call recordings in Cloudflare R2 by configuring your R2 credential and bucket in Cloud Providers, uploading recordings when each conversation ends. --- Your assistants can be configured to record chat conversations and upload diff --git a/fern/providers/cloud/gcp.mdx b/fern/providers/cloud/gcp.mdx index ce441a478..cad57b071 100644 --- a/fern/providers/cloud/gcp.mdx +++ b/fern/providers/cloud/gcp.mdx @@ -2,6 +2,7 @@ title: GCP Cloud Storage subtitle: Store recordings of chat conversations in GCP Cloud Storage slug: providers/cloud/gcp +description: Store Vapi call recordings in Google Cloud Storage by configuring your GCP credential and bucket in Cloud Providers, uploading recordings when a call ends. --- Your assistants can be configured to record chat conversations and upload diff --git a/fern/providers/cloud/s3.mdx b/fern/providers/cloud/s3.mdx index 4e136dacc..38552e56b 100644 --- a/fern/providers/cloud/s3.mdx +++ b/fern/providers/cloud/s3.mdx @@ -2,6 +2,7 @@ title: AWS S3 subtitle: Store recordings of chat conversations in AWS S3 slug: providers/cloud/s3 +description: Store Vapi call recordings in AWS S3 by configuring your S3 credential and bucket in Cloud Providers, uploading recordings when each conversation ends. --- Your assistants can be configured to record chat conversations and upload diff --git a/fern/providers/cloud/supabase.mdx b/fern/providers/cloud/supabase.mdx index aae166364..edc2582a1 100644 --- a/fern/providers/cloud/supabase.mdx +++ b/fern/providers/cloud/supabase.mdx @@ -2,6 +2,7 @@ title: Supabase S3 Storage subtitle: Store recordings of chat conversations in Supabase Storage slug: providers/cloud/supabase +description: Store Vapi call recordings in Supabase Storage by configuring your Supabase credential and bucket in Cloud Providers, uploading recordings when a call ends. --- Your assistants can be configured to record chat conversations and upload diff --git a/fern/providers/sympana-connector.mdx b/fern/providers/sympana-connector.mdx index 70757e18c..3bfaf3de7 100644 --- a/fern/providers/sympana-connector.mdx +++ b/fern/providers/sympana-connector.mdx @@ -2,6 +2,7 @@ title: Sympana Connector subtitle: Native GoHighLevel automation for Vapi agents slug: providers/sympana-connector +description: Connect Vapi agents to GoHighLevel with Sympana Connector, a managed automation layer for outbound sequences, inbound routing, and CRM syncing inside GHL. --- ## Overview diff --git a/fern/providers/vapify.mdx b/fern/providers/vapify.mdx index a2417a16c..e2f2ea933 100644 --- a/fern/providers/vapify.mdx +++ b/fern/providers/vapify.mdx @@ -2,6 +2,7 @@ title: Vapify Integration with Vapi subtitle: 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. slug: providers/vapify +description: Integrate Vapify with Vapi to run a white-label voice AI agency without code, giving your clients a branded dashboard and the tools to sell and deliver agents. --- Vapify is a white-label platform for Vapi that simplifies how agencies sell and deliver Vapi-powered voice AI solutions. It provides a business infrastructure that helps drive agency growth and profitability. diff --git a/fern/providers/voice/vapi-voices/legacy-migration.mdx b/fern/providers/voice/vapi-voices/legacy-migration.mdx index 0d4b02489..397e4eadc 100644 --- a/fern/providers/voice/vapi-voices/legacy-migration.mdx +++ b/fern/providers/voice/vapi-voices/legacy-migration.mdx @@ -2,6 +2,7 @@ title: Legacy voice migration guide subtitle: Legacy Vapi Voices were retired on March 1, 2026. Here's what changed and how to update if needed. slug: providers/voice/vapi-voices/legacy-migration +description: Migrate from legacy Vapi Voices retired on March 1, 2026, seeing which voices were removed, the new human voice clones, and how to update your assistants. --- ## Voice availability update diff --git a/fern/providers/voiceaiwrapper.mdx b/fern/providers/voiceaiwrapper.mdx index e3e6a6eb5..9a20b21cf 100644 --- a/fern/providers/voiceaiwrapper.mdx +++ b/fern/providers/voiceaiwrapper.mdx @@ -2,6 +2,7 @@ title: VoiceAIWrapper Integration with Vapi subtitle: White-Label Vapi Integration | Launch Your Voice AI Agency in 30 Minutes slug: providers/voiceaiwrapper +description: Integrate VoiceAIWrapper with Vapi to launch a white-label voice AI agency, adding client onboarding, billing, and campaign management on top of Vapi's APIs. --- ## Overview diff --git a/fern/providers/voiceflow.mdx b/fern/providers/voiceflow.mdx index b44acee45..a0d92ba77 100644 --- a/fern/providers/voiceflow.mdx +++ b/fern/providers/voiceflow.mdx @@ -2,6 +2,7 @@ title: Voiceflow subtitle: Vapi x Voiceflow slug: providers/voiceflow +description: Connect Vapi with Voiceflow by hosting a proxy that routes Voiceflow requests to Vapi's text completion API and returns responses to your Voiceflow agent. --- diff --git a/fern/quickstart.mdx b/fern/quickstart.mdx index 9794f8956..f906fa19c 100644 --- a/fern/quickstart.mdx +++ b/fern/quickstart.mdx @@ -2,6 +2,7 @@ title: Core Models subtitle: Learn about the three core components to Vapi's voice AI pipeline. slug: quickstart +description: Understand Vapi's three core components, the transcriber, model, and voice, and how Vapi orchestrates them into a low-latency, human-sounding conversation. --- diff --git a/fern/quickstart/introduction.mdx b/fern/quickstart/introduction.mdx index be6e660ff..acd67243a 100644 --- a/fern/quickstart/introduction.mdx +++ b/fern/quickstart/introduction.mdx @@ -2,6 +2,7 @@ title: Introduction subtitle: Build voice AI agents that can make and receive phone calls slug: quickstart/introduction +description: Get started with Vapi, the developer platform for building voice AI agents that make and receive phone calls, handling the infrastructure so you can build. --- ## What is Vapi? diff --git a/fern/quickstart/phone.mdx b/fern/quickstart/phone.mdx index 138025868..b2c408e1a 100644 --- a/fern/quickstart/phone.mdx +++ b/fern/quickstart/phone.mdx @@ -2,6 +2,7 @@ title: Phone calls subtitle: Learn to make your first phone call with a voice agent slug: quickstart/phone +description: Make your first Vapi phone call in minutes, creating a voice agent in the Dashboard or programmatically and talking to it over the phone. --- ## Overview diff --git a/fern/quickstart/web.mdx b/fern/quickstart/web.mdx index 4aae6431f..133e3396e 100644 --- a/fern/quickstart/web.mdx +++ b/fern/quickstart/web.mdx @@ -2,6 +2,7 @@ title: Web calls subtitle: Build voice interfaces and backend integrations using Vapi's Web and Server SDKs slug: quickstart/web +description: Build voice interfaces and backend integrations with Vapi's Web and Server SDKs, covering client-side voice apps and server-side call management. --- ## Overview diff --git a/fern/resources.mdx b/fern/resources.mdx index 2ef1f4277..c928ab303 100644 --- a/fern/resources.mdx +++ b/fern/resources.mdx @@ -2,6 +2,7 @@ title: Ecosystem subtitle: Find all of our resources here. slug: resources +description: Explore the Vapi ecosystem in one place, with links to the CLI, client and server SDKs, code examples, MCP server, API reference, and community resources. --- diff --git a/fern/rss-feed.mdx b/fern/rss-feed.mdx index 9045ad744..604cccad8 100644 --- a/fern/rss-feed.mdx +++ b/fern/rss-feed.mdx @@ -2,6 +2,7 @@ title: RSS Feed subtitle: Stay updated with the latest incidents from Vapi or third party providers slug: rss-feed +description: Subscribe to Vapi's status RSS feed to track the latest incidents from Vapi and underlying providers, including how to add the feed in Slack. --- ## RSS Feed diff --git a/fern/sdk/mcp-server.mdx b/fern/sdk/mcp-server.mdx index 8631c79bb..091200f24 100644 --- a/fern/sdk/mcp-server.mdx +++ b/fern/sdk/mcp-server.mdx @@ -2,6 +2,7 @@ title: Vapi MCP Server subtitle: Connect Vapi to AI assistants with Model Context Protocol (MCP) slug: sdk/mcp-server +description: Use the Vapi MCP Server to expose Vapi APIs as tools over the Model Context Protocol, managing assistants, phone numbers, and calls from any MCP client. --- ## Overview diff --git a/fern/sdks.mdx b/fern/sdks.mdx index 96b1860c8..d6bd002c3 100644 --- a/fern/sdks.mdx +++ b/fern/sdks.mdx @@ -2,6 +2,7 @@ title: Client SDKs subtitle: Put Vapi assistants on every platform. slug: sdks +description: Add Vapi assistants to any platform with the client SDKs for web, iOS, Flutter, React Native, and Python, which handle audio streaming and call setup. --- The Vapi Client SDKs automatically configure audio streaming to and from the client, and provide a simple interface for starting calls. The interface is equivalent across all the SDKs. diff --git a/fern/security-and-privacy/GDPR.mdx b/fern/security-and-privacy/GDPR.mdx index 6a22ea004..d2c3836ff 100644 --- a/fern/security-and-privacy/GDPR.mdx +++ b/fern/security-and-privacy/GDPR.mdx @@ -2,6 +2,7 @@ title: "GDPR Compliance" subtitle: Learn how Vapi ensures GDPR compliance for its voice assistant platform. slug: security-and-privacy/GDPR +description: How Vapi handles personal data under GDPR, covering data processing, legal bases, data subject rights, and the security measures protecting user data. --- At Vapi, safeguarding your personal data is our top priority. In full alignment with the General Data Protection Regulation (GDPR), we maintain robust standards for data protection and privacy. This document provides an overview of our data processing practices, legal bases, data subject rights, and the security measures we employ—all designed to ensure that your data is managed with the utmost care. diff --git a/fern/security-and-privacy/PCI.mdx b/fern/security-and-privacy/PCI.mdx index 5cb75529c..34b9ae552 100644 --- a/fern/security-and-privacy/PCI.mdx +++ b/fern/security-and-privacy/PCI.mdx @@ -2,6 +2,7 @@ title: PCI Compliance subtitle: Ensure secure payment data handling while using Vapi’s voice assistant platform. slug: security-and-privacy/pci +description: How Vapi handles payment data securely on its voice AI platform, explaining PCI compliance and the practices that protect sensitive financial information. --- diff --git a/fern/security-and-privacy/proxy-server.mdx b/fern/security-and-privacy/proxy-server.mdx index d96204000..5ba87ab7b 100644 --- a/fern/security-and-privacy/proxy-server.mdx +++ b/fern/security-and-privacy/proxy-server.mdx @@ -2,6 +2,7 @@ title: Proxy server guide subtitle: Keep assistant configs and API keys on your backend. Route Web SDK calls through your proxy. slug: security-and-privacy/proxy-server +description: Keep Vapi assistant configs and API keys on your backend by routing Web SDK calls through a proxy server that maps frontend data to Vapi API calls. --- ## Overview diff --git a/fern/security-and-privacy/soc.mdx b/fern/security-and-privacy/soc.mdx index 09cd2c615..98f557770 100644 --- a/fern/security-and-privacy/soc.mdx +++ b/fern/security-and-privacy/soc.mdx @@ -1,5 +1,6 @@ --- title: SOC-2 Compliance slug: security-and-privacy/soc +description: Vapi's SOC 2 compliance for its voice AI platform. Find the SOC 2 report and audited security controls in the Vapi security center. --- diff --git a/fern/security-and-privacy/sso.mdx b/fern/security-and-privacy/sso.mdx index cc36a3643..ba79a388f 100644 --- a/fern/security-and-privacy/sso.mdx +++ b/fern/security-and-privacy/sso.mdx @@ -2,6 +2,7 @@ title: Single Sign-On (SSO) subtitle: Let your team access Vapi through your identity provider using SAML or OIDC. slug: security-and-privacy/sso +description: Let your team sign in to Vapi through your identity provider with SAML or OIDC, an enterprise feature supporting Google Workspace, Microsoft Entra ID, and Okta. --- diff --git a/fern/security-and-privacy/static-ip-addresses.mdx b/fern/security-and-privacy/static-ip-addresses.mdx index 16731e5ce..22f715e6d 100644 --- a/fern/security-and-privacy/static-ip-addresses.mdx +++ b/fern/security-and-privacy/static-ip-addresses.mdx @@ -2,6 +2,7 @@ title: Static IP addresses subtitle: Whitelist Vapi IP addresses slug: security-and-privacy/static-ip-addresses +description: Route Vapi's outbound HTTP requests through a fixed set of static IP addresses, so you can allowlist them and apply strict firewall and network rules. --- diff --git a/fern/security-and-privacy/tos.mdx b/fern/security-and-privacy/tos.mdx index 5b87b1d20..9fad39594 100644 --- a/fern/security-and-privacy/tos.mdx +++ b/fern/security-and-privacy/tos.mdx @@ -1,6 +1,7 @@ --- title: Terms of Service slug: security-and-privacy/tos +description: Find Vapi's Terms of Service, hosted at vapi.ai, governing use of the Vapi voice AI platform. --- diff --git a/fern/server-url.mdx b/fern/server-url.mdx index 3d927844d..bf436efb8 100644 --- a/fern/server-url.mdx +++ b/fern/server-url.mdx @@ -2,6 +2,7 @@ title: Server URLs subtitle: Learn how to set up your server to receive and respond to messages from Vapi. slug: server-url +description: Set up server URLs so your application receives Vapi call events like status updates, transcripts, function calls, and end-of-call reports, and responds. --- diff --git a/fern/server-url/developing-locally.mdx b/fern/server-url/developing-locally.mdx index fff7420c7..aaf9c49cd 100644 --- a/fern/server-url/developing-locally.mdx +++ b/fern/server-url/developing-locally.mdx @@ -2,6 +2,7 @@ title: Developing locally subtitle: Learn how to receive server events in your local development environment. slug: server-url/developing-locally +description: Receive Vapi server events in local development using the Vapi CLI webhook forwarder and a tunneling service to route webhook payloads to your machine. --- diff --git a/fern/server-url/events.mdx b/fern/server-url/events.mdx index cd3c98520..6ccfb14a2 100644 --- a/fern/server-url/events.mdx +++ b/fern/server-url/events.mdx @@ -2,6 +2,7 @@ title: Server events subtitle: Learn about different events that can be sent to a Server URL. slug: server-url/events +description: Reference the events Vapi POSTs to your Server URL, with the shared message body shape and the payload fields that vary by server message type. --- All messages sent to your Server URL are `POST` requests with this body shape: diff --git a/fern/server-url/server-authentication.mdx b/fern/server-url/server-authentication.mdx index 11d01d402..0c4f77d18 100644 --- a/fern/server-url/server-authentication.mdx +++ b/fern/server-url/server-authentication.mdx @@ -1,6 +1,7 @@ --- title: Server authentication slug: server-url/server-authentication +description: Authenticate Vapi webhooks to your server with custom credentials referenced by credentialId, reusing them across assistants, phone numbers, and tools. --- When configuring webhooks for your assistant, you can authenticate your server endpoints by creating **Custom Credentials** and referencing them using a `credentialId`. This approach provides better security, reusability, and centralized management of your authentication credentials. diff --git a/fern/server-url/setting-server-urls.mdx b/fern/server-url/setting-server-urls.mdx index 9f1569397..098db175c 100644 --- a/fern/server-url/setting-server-urls.mdx +++ b/fern/server-url/setting-server-urls.mdx @@ -2,6 +2,7 @@ title: Setting server URLs subtitle: Learn about where you can set server URLs to handle call events. slug: server-url/setting-server-urls +description: Set Vapi server URLs at multiple levels to handle call events, and learn how priority decides which URL receives a given event. --- diff --git a/fern/server-url/spam-call-rejection.mdx b/fern/server-url/spam-call-rejection.mdx index 8baf0929b..9081874dc 100644 --- a/fern/server-url/spam-call-rejection.mdx +++ b/fern/server-url/spam-call-rejection.mdx @@ -2,6 +2,7 @@ title: Spam call rejection subtitle: Screen inbound calls and reject known spam using your Server URL slug: server-url/spam-call-rejection +description: Screen inbound Vapi calls with your Server URL, checking the caller number on an assistant-request to reject known spam or return an assistant to proceed. --- Use your Server URL to filter inbound calls before they reach your assistant. When an inbound call arrives, Vapi can ask your server which assistant to use via an `assistant-request`. In that moment, you can check the caller's phone number against your spam list: diff --git a/fern/squads-example.mdx b/fern/squads-example.mdx index ff483383b..66c128e3d 100644 --- a/fern/squads-example.mdx +++ b/fern/squads-example.mdx @@ -2,6 +2,7 @@ title: Configuring Inbound and Outbound Calls for Squads subtitle: Configuring assistants for inbound/outbound calls. slug: squads-example +description: Configure inbound and outbound calls for Vapi Squads, handling assistant-request payloads with transient assistants or assistant IDs for each call type. --- diff --git a/fern/squads.mdx b/fern/squads.mdx index 0692cabfc..0fc8ddd4f 100644 --- a/fern/squads.mdx +++ b/fern/squads.mdx @@ -2,6 +2,7 @@ title: Introduction to Squads (Multi-Assistant Conversations) subtitle: Use Squads to handle complex workflows and tasks. slug: squads +description: Break complex workflows into multiple specialized Vapi assistants that hand off during a call, reducing hallucination, cost, and latency versus one assistant. --- Squads let you break complex workflows into multiple specialized assistants that hand off to each other during a conversation. Each assistant in a Squad handles a specific part of your workflow; for example, one assistant for lead qualification that transfers to another for appointment booking. diff --git a/fern/squads/handoff.mdx b/fern/squads/handoff.mdx index 9213807c9..7ee9baa1e 100644 --- a/fern/squads/handoff.mdx +++ b/fern/squads/handoff.mdx @@ -2,6 +2,7 @@ title: Handoff tool subtitle: 'Transfer the call to another assistant, squad, or dynamically determined destination.' slug: squads/handoff +description: Transfer a Vapi call between assistants with the handoff tool, covering destination types, context management, and configuration for multi-agent squads. --- The handoff tool enables seamless call transfers between assistants in a multi-agent system. This guide covers all configuration patterns, destination types, context management, and advanced features. diff --git a/fern/squads/passing-data-between-assistants.mdx b/fern/squads/passing-data-between-assistants.mdx index 4ea3899ee..f9d2588bf 100644 --- a/fern/squads/passing-data-between-assistants.mdx +++ b/fern/squads/passing-data-between-assistants.mdx @@ -2,6 +2,7 @@ title: Passing data between assistants subtitle: Three approaches for forwarding context to the next assistant in a squad — when to use each, and what each one costs. slug: squads/passing-data-between-assistants +description: Forward context to the next assistant in a Vapi squad using three handoff mechanisms, with a decision guide on their latency, accuracy, and trade-offs. --- When an assistant in a squad hands off to another assistant, you usually need to forward something — the caller's name, an extracted intent, an upstream tool's result, a session ID. Vapi gives you **three different mechanisms** to do this. Each one trades off latency, accuracy, and where the value comes from. Picking the wrong one is the single most common reason squad handoffs feel slow or unreliable. diff --git a/fern/squads/silent-handoffs.mdx b/fern/squads/silent-handoffs.mdx index 637db598c..0283e682e 100644 --- a/fern/squads/silent-handoffs.mdx +++ b/fern/squads/silent-handoffs.mdx @@ -1,6 +1,7 @@ --- title: Silent Handoffs slug: squads/silent-handoffs +description: Hand off a Vapi call between squad assistants silently, so the caller never hears a transfer, by configuring the destination assistant's first message. --- - **The Problem**: In traditional AI call flows, when handing off from one agent to another, announcing the handoff verbally can confuse or annoy callers and disrupt the conversation's flow. - **The Solution**: Silent handoffs keep the call experience _uninterrupted_, so the user doesn’t know multiple assistants are involved. The conversation flows more naturally, boosting customer satisfaction. diff --git a/fern/support.mdx b/fern/support.mdx index 0a05770a2..14b8b2094 100644 --- a/fern/support.mdx +++ b/fern/support.mdx @@ -4,6 +4,7 @@ subtitle: >- We are open to all kinds of help inquiry, feedback and feature request, help inquiry. slug: support +description: Get help with your Vapi projects through email, the Discord developer community, and enterprise support options for account and technical questions. --- ## Our Support Options diff --git a/fern/tcpa-consent.mdx b/fern/tcpa-consent.mdx index 9bc1cb8b9..f64eea684 100644 --- a/fern/tcpa-consent.mdx +++ b/fern/tcpa-consent.mdx @@ -2,6 +2,7 @@ title: TCPA Consent Guide subtitle: Understanding consent requirements for outbound calls using Vapi's voice agent service. slug: tcpa-consent +description: Understand TCPA consent requirements for outbound Vapi calls, including prior express written consent for marketing and prior express consent for other calls. --- This guide details the consent requirements under the Telephone Consumer Protection Act (TCPA) for callers using Vapi's voice agent service to make outbound telephone calls. diff --git a/fern/test/chat-testing.mdx b/fern/test/chat-testing.mdx index 29a7c15d6..23e87d5c6 100644 --- a/fern/test/chat-testing.mdx +++ b/fern/test/chat-testing.mdx @@ -2,6 +2,7 @@ title: Chat Testing subtitle: Automated text-based testing for AI agents slug: /test/chat-testing +description: Test Vapi AI agents with automated text conversations using Chat Test Suites, the faster way to isolate and evaluate agent behavior before production. --- ## Overview diff --git a/fern/test/test-suites.mdx b/fern/test/test-suites.mdx index 2787d214f..c137186ae 100644 --- a/fern/test/test-suites.mdx +++ b/fern/test/test-suites.mdx @@ -2,6 +2,7 @@ title: Test Suites subtitle: End-to-end test automation for AI voice agents slug: /test/test-suites +description: Run end-to-end automated tests on Vapi voice agents with Test Suites, now being replaced by Simulations as the more powerful way to test your agents. --- diff --git a/fern/test/voice-testing.mdx b/fern/test/voice-testing.mdx index 2c1644b60..818314278 100644 --- a/fern/test/voice-testing.mdx +++ b/fern/test/voice-testing.mdx @@ -2,6 +2,7 @@ title: Voice Testing subtitle: Automated voice call testing for AI voice agents slug: /test/voice-testing +description: Test Vapi voice agents with Voice Test Suites, connecting your agent to a testing agent on a real phone call to evaluate performance against your scripts. --- ## Overview diff --git a/fern/tools/api-request-vs-function.mdx b/fern/tools/api-request-vs-function.mdx index 2a0724e4c..be112b6b7 100644 --- a/fern/tools/api-request-vs-function.mdx +++ b/fern/tools/api-request-vs-function.mdx @@ -2,6 +2,7 @@ title: API Request Tool vs Function Tool subtitle: Choose API Request for direct HTTP APIs and Function for Vapi tool-calls webhooks. slug: tools/api-request-vs-function +description: Compare Vapi's API Request and Function tools, choosing API Request for direct HTTPS APIs and Function for tool-calls webhooks or async and client-side execution. --- Use an **API Request Tool** when your assistant needs to call an ordinary HTTPS API. Use a **Function Tool** when your server implements Vapi's `tool-calls` webhook protocol, or when the tool must run asynchronously or on the client. diff --git a/fern/tools/arguments-encryption.mdx b/fern/tools/arguments-encryption.mdx index d7b4978c0..5188bcde3 100644 --- a/fern/tools/arguments-encryption.mdx +++ b/fern/tools/arguments-encryption.mdx @@ -2,6 +2,7 @@ title: Tool Arguments Encryption subtitle: Learn to encrypt tool arguments and protect sensitive data slug: tools/encryption +description: Encrypt sensitive tool arguments like SSNs and card numbers in Vapi, protecting specific fields before they are sent to your server during a tool call. --- ## Overview diff --git a/fern/tools/client-side-websdk.mdx b/fern/tools/client-side-websdk.mdx index ce9ba1a08..267404cad 100644 --- a/fern/tools/client-side-websdk.mdx +++ b/fern/tools/client-side-websdk.mdx @@ -2,6 +2,7 @@ title: Client-side Tools (Web SDK) subtitle: Handle tool-calls in the browser without a server URL slug: tools/client-side-websdk +description: Handle Vapi tool calls entirely in the browser with the Web SDK, triggering UI side effects like notifications or state changes without a server URL. --- ## Overview diff --git a/fern/tools/custom-tools.mdx b/fern/tools/custom-tools.mdx index 9b602dfbf..fcd4c66a8 100644 --- a/fern/tools/custom-tools.mdx +++ b/fern/tools/custom-tools.mdx @@ -2,6 +2,7 @@ title: Custom (Function) Tools subtitle: Create custom tools, including Function Tools that connect your assistant to server-side logic. slug: tools/custom-tools +description: Create custom tools, including Function tools, for Vapi assistants using the dashboard's visual Tools section or the API to connect to your server-side logic. --- This guide shows you how to create custom tools, including Function Tools, for your Vapi assistants. We recommend using the Vapi dashboard's dedicated Tools section, which provides a visual interface for creating and managing tools that can be reused across multiple assistants. For advanced users, API configuration is also available. diff --git a/fern/tools/default-tools.mdx b/fern/tools/default-tools.mdx index 339b4f02a..997071a90 100644 --- a/fern/tools/default-tools.mdx +++ b/fern/tools/default-tools.mdx @@ -2,6 +2,7 @@ title: Default Tools subtitle: 'Adding Transfer Call, End Call, Dial Keypad, and API Request capabilities to your assistants.' slug: tools/default-tools +description: Add Vapi's built-in default tools to assistants, including transfer call, end call, SMS, DTMF keypad, and API request, through the API or dashboard. --- Vapi voice assistants are given additional functions: `transferCall`, `endCall`, `sms`, `dtmf` (to dial a keypad with [DTMF](https://en.wikipedia.org/wiki/DTMF)), and `apiRequest`. These functions can be used to transfer calls, hang up calls, send SMS messages, enter digits on the keypad, and integrate business logic with your existing APIs. diff --git a/fern/tools/go-high-level.mdx b/fern/tools/go-high-level.mdx index ab7a5827c..33bc89568 100644 --- a/fern/tools/go-high-level.mdx +++ b/fern/tools/go-high-level.mdx @@ -2,6 +2,7 @@ title: GoHighLevel Integration subtitle: "Connect your assistant to GoHighLevel for seamless appointment scheduling, contact creation, and availability checking." slug: tools/go-high-level +description: Connect a Vapi assistant to GoHighLevel to manage appointments, checking contacts, creating leads, querying calendar availability, and booking events. --- The GoHighLevel integration empowers your Vapi voice agents to directly interact with your clients\' GoHighLevel calendars. Your agents can use a suite of tools to manage the appointment lifecycle: check if a contact already exists using the **Get Contact** tool, create new leads or clients with the **Create Contact** tool, query specific GHL calendars for open slots via the **Check Availability** tool, and secure appointments associated with a contact using the **Create Event** tool. This enables your voice agent to handle the entire booking process seamlessly within the GHL calendar that your agency or client already uses. diff --git a/fern/tools/google-calendar.mdx b/fern/tools/google-calendar.mdx index fba2cb110..fa7dad079 100644 --- a/fern/tools/google-calendar.mdx +++ b/fern/tools/google-calendar.mdx @@ -2,6 +2,7 @@ title: Google Calendar Integration subtitle: 'Connect your assistant to Google Calendar for seamless appointment scheduling and availability checking.' slug: tools/google-calendar +description: Connect a Vapi assistant to Google Calendar to create events by voice and check availability, letting it schedule appointments during a call. --- The Google Calendar integration allows your Vapi assistant to interact with Google Calendar in two ways: diff --git a/fern/tools/google-sheets.mdx b/fern/tools/google-sheets.mdx index b9c1ad5c9..56eee63d9 100644 --- a/fern/tools/google-sheets.mdx +++ b/fern/tools/google-sheets.mdx @@ -2,6 +2,7 @@ title: Google Sheets Integration subtitle: 'Connect your assistant to Google Sheets for seamless data entry.' slug: tools/google-sheets +description: Connect a Vapi assistant to Google Sheets to add new rows during phone calls, recording caller information and data directly into your spreadsheets. --- The Google Sheets integration allows your Vapi assistant to interact with Google Sheets in a simple way: diff --git a/fern/tools/introduction.mdx b/fern/tools/introduction.mdx index 5a0755051..233784eaf 100644 --- a/fern/tools/introduction.mdx +++ b/fern/tools/introduction.mdx @@ -2,6 +2,7 @@ title: Introduction to Tools subtitle: Extend your assistant's capabilities with powerful function calling tools. slug: tools +description: Extend Vapi assistants with tools that transfer calls, fetch external data, and trigger actions, using built-in default tools or custom tools you create. --- [**Tools**](/api-reference/tools/create) allow your assistant to take actions beyond just conversation. They enable your assistant to perform tasks like transferring calls, accessing external data, or triggering actions in your application. Tools can be either built-in default tools provided by Vapi or custom tools that you create. Tools are also [versioned](/assistants/versioning). When you configure an assistant, you choose whether it uses a specific version of a tool or always the latest. diff --git a/fern/tools/mcp.mdx b/fern/tools/mcp.mdx index e11b782fc..90bd3425e 100644 --- a/fern/tools/mcp.mdx +++ b/fern/tools/mcp.mdx @@ -2,6 +2,7 @@ title: Model Context Protocol (MCP) Integration subtitle: 'Connect your assistant to dynamic tools through MCP servers for enhanced capabilities.' slug: tools/mcp +description: Connect a Vapi assistant to MCP servers to access tools dynamically at runtime, letting it use any MCP-compatible server's capabilities during a call. --- The Model Context Protocol (MCP) integration allows your Vapi assistant to dynamically access tools from MCP servers during calls. This enables your assistant to: diff --git a/fern/tools/slack.mdx b/fern/tools/slack.mdx index 716fb5f32..f3067a8b4 100644 --- a/fern/tools/slack.mdx +++ b/fern/tools/slack.mdx @@ -2,6 +2,7 @@ title: Slack Integration subtitle: 'Connect your assistant to Slack for seamless message sending.' slug: tools/slack +description: Connect a Vapi assistant to Slack to send messages to a configured channel during phone calls, notifying your team or sharing updates in real time. --- The Slack integration allows your Vapi assistant to send messages to a pre-configured Slack channel during phone calls. This enables your assistant to notify team members, send updates, or share information directly through Slack. diff --git a/fern/tools/static-variables-and-aliases.mdx b/fern/tools/static-variables-and-aliases.mdx index ed2cde945..2d50c0fb9 100644 --- a/fern/tools/static-variables-and-aliases.mdx +++ b/fern/tools/static-variables-and-aliases.mdx @@ -2,6 +2,7 @@ title: Static variables and aliases subtitle: Inject server-controlled values into tool calls without LLM involvement, and chain values across tool calls deterministically. slug: tools/static-variables-and-aliases +description: Inject server-controlled values into Vapi tool calls without the LLM, using static variables and aliases to chain data across calls deterministically. --- ## Overview diff --git a/fern/tools/tool-rejection-plan.mdx b/fern/tools/tool-rejection-plan.mdx index d8ade83fb..961e1ffad 100644 --- a/fern/tools/tool-rejection-plan.mdx +++ b/fern/tools/tool-rejection-plan.mdx @@ -2,6 +2,7 @@ title: Tool rejection plan subtitle: Prevent unintended tool calls using conditions based on conversation state slug: tools/tool-rejection-plan +description: Prevent unintended Vapi tool calls with a rejection plan that evaluates recent conversation state and blocks a tool when your conditions are met. --- ## Overview diff --git a/fern/tools/voicemail-tool.mdx b/fern/tools/voicemail-tool.mdx index 0d651d0f0..9b8e115d6 100644 --- a/fern/tools/voicemail-tool.mdx +++ b/fern/tools/voicemail-tool.mdx @@ -2,6 +2,7 @@ title: Voicemail Tool subtitle: Learn how to use the assistant-controlled voicemail tool for flexible voicemail handling slug: tools/voicemail-tool +description: Give a Vapi assistant direct control over voicemail with the voicemail tool, deciding when it reaches voicemail to leave a message or end the call. --- ## Overview diff --git a/fern/voice-fallback-plan.mdx b/fern/voice-fallback-plan.mdx index b0ececd41..a80992669 100644 --- a/fern/voice-fallback-plan.mdx +++ b/fern/voice-fallback-plan.mdx @@ -2,6 +2,7 @@ title: Voice fallback configuration subtitle: Configure fallback voices that activate automatically if your primary voice fails. slug: voice-fallback-plan +description: Configure fallback voices in Vapi that activate automatically when your primary voice provider fails, switching through your ordered list to keep calls live. --- ## Overview