Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-chime.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-networking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-plivo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-telnyx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-trunk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-twilio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<Frame>
Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip-zadarma.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---


Expand Down
1 change: 1 addition & 0 deletions fern/advanced/sip/sip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/assistant-hooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/background-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/call-analysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/dynamic-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/email-address-reading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/examples/docs-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/examples/voice-widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/idle-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/personalization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/pronunciation-dictionaries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/structured-outputs-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/assistants/voice-formatting-plan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/calls/call-ended-reason.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
1 change: 1 addition & 0 deletions fern/calls/call-features.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions fern/calls/call-handling-with-vapi-and-twilio.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/calls/call-outbound.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/calls/troubleshoot-call-errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/calls/troubleshoot-call-forwarding-drops.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/calls/voicemail-detection.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<Warning>
Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-keywords.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---


Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-llm/fine-tuned-openai-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---


Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-llm/tool-calling-integration.mdx
Original file line number Diff line number Diff line change
@@ -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?

Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-llm/using-your-server.mdx
Original file line number Diff line number Diff line change
@@ -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.
---


Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-transcriber.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-tts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-voices/custom-voice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-voices/elevenlabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/customization/custom-voices/playht.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/customization/jwt-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/customization/speech-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/debugging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/enterprise/dev-uat-prod.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions fern/enterprise/plans.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<Markdown src="./snippets/faq-snippet.mdx" />
1 change: 1 addition & 0 deletions fern/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---


Expand Down
1 change: 1 addition & 0 deletions fern/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<Frame>
Expand Down
1 change: 1 addition & 0 deletions fern/issue-reporting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions fern/ivr-navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading