-
- Join the Vapi Discord for real-time help from the community and team
-
-
- Check the API reference for detailed configuration options
-
-
- Check real-time status of Vapi services and AI providers
-
-
- Built with Workflows
+ Built with Assistants
Build an appointment scheduling assistant that can schedule appointments for a barbershop
-
- Built with Workflows
+ Built with Squads
Build a medical triage and scheduling assistant that can triage patients and schedule appointments for a clinic
-
- Built with Workflows
+ Built with Squads
Build an ecommerce order management assistant that can track orders and process returns
-
- Built with Workflows
+ Built with Squads
Build a call routing workflow that dynamically routes tenant calls based on verification and inquiry type
-
- Built with Workflows
+ Built with Assistants
Create an outbound sales agent that can schedule appointments automatically
-
- Built with Workflows
+ Built with Squads
Build a structured multilingual support workflow with language selection and dedicated conversation paths
-
Built with Assistants
Build a dynamic agent with automatic language detection and real-time language switching
-
Built with Assistants
Build an intelligent support escalation system with dynamic routing based on customer tier and issue complexity
-
Built with Assistants
Build a docs agent that can answer questions about your documentation
-
Built with Assistants
Build a technical support assistant that remembers where you left off between calls
-
Built with Assistants
Easily integrate the Vapi Voice Widget into your website for enhanced user interaction
-
Developer Tool
Build voice AI agents faster with the Vapi CLI - project integration, local testing, and IDE enhancement diff --git a/fern/ivr-navigation.mdx b/fern/ivr-navigation.mdx index 280a8e510..38667ea31 100644 --- a/fern/ivr-navigation.mdx +++ b/fern/ivr-navigation.mdx @@ -95,3 +95,39 @@ DTMF sending varies across telephony providers due to internal implementations. - **Try and compare**: Twilio, Telnyx, Vonage, Vapi Numbers, and BYOK SIP - **Evaluate**: digit recognition accuracy, latency between digits, and success rate across menu depths. +### 5. Enter multiple keypad entries at once + +Some IVRs ask for several digits or letters in a single prompt (for example, by‑name directories that require the first three letters of a last name). In these cases, send all required keys in a single `dtmf` call, using pause characters between keys so the IVR reliably registers them. + +- **How**: Use `keys` with a combined sequence, inserting `w` (0.5s pause) or `W` (1s pause) between entries. +- **Why**: Multiple separate `dtmf` calls can arrive too slowly or be partially ignored; a single combined sequence is more consistent. + +```json title="Single dtmf with multiple keys" +{ + "role": "tool_calls", + "time": 1760710106938, + "message": "", + "toolCalls": [ + { + "id": "call_CTgHfSj4lNZaqVjByk2eJooc", + "type": "function", + "function": { + "name": "dtmf", + "arguments": "{\"keys\": \"w2w1w2\"}" + } + } + ], + "secondsFromStart": 25.16 +} +``` + +```txt title="By‑name directory example" +# If the IVR says: "Enter the first 3 letters of the last name" +# Map letters to digits using the IVR's on‑screen or spoken mapping (e.g., S=7, M=6, I=4) +dtmf(keys=w7w6w4) +``` + +
+ **Important**: You must explicitly instruct your assistant in its system prompt about when to use the query tool. The knowledge base description alone is not sufficient for the assistant to know when to search.
+
+
+Add clear instructions to your assistant's system messages, **explicitly naming the tool**:
```json
-"description": "Use this knowledge base when the user asks about pricing, subscription plans, or billing information"
+{
+ "role": "system",
+ "content": "You are a helpful customer support assistant. When users ask about products, pricing, features, or need troubleshooting help, use the 'knowledge-search' tool to search our knowledge base for accurate information. Always call the knowledge-search tool before providing answers to ensure accuracy."
+}
```
+
+
+
+## Best Practices
+
+- **Operating Point** – Select the **Enhanced** model for the best accuracy in real-time voice agents.
+- **Region** – Choose the region closest to your users to optimize latency.
+- **Custom Vocabulary** – Use this feature to add key terms (e.g., product names) and leverage the *Sounds Like* option for tricky pronunciations.
diff --git a/fern/providers/voice/vapi-voices.mdx b/fern/providers/voice/vapi-voices.mdx
index 2c20f9a99..2efc78db7 100644
--- a/fern/providers/voice/vapi-voices.mdx
+++ b/fern/providers/voice/vapi-voices.mdx
@@ -4,6 +4,10 @@ subtitle: Our curated selection of high-quality voices
slug: providers/voice/vapi-voices
---
+
-
- **Best for:** Quick kickstart for simple conversations
+ **Best for:** Most use cases and fast iteration
- Assistants use a single system prompt to control behavior. Perfect for: - - Customer support chatbots - - Simple question-answering agents - - Getting started quickly with minimal setup + Assistants use a single system prompt plus tools and structured outputs. Perfect for: + - Customer support + - Lead qualification + - Booking and routing
-
- **Best for:** Complex logic and multi-step processes
+ **Best for:** Multi-assistant setups with specialization
- Workflows use visual decision trees and conditional logic. Perfect for: - - Appointment scheduling with availability checks - - Lead qualification with branching questions - - Complex customer service flows with escalation + Squads orchestrate multiple assistants with context-preserving transfers. Ideal for: + - Medical triage and scheduling + - E‑commerce orders, returns, VIP + - Property management routing
-
- Create a voice agent for inbound/outbound calls
- Build customer support or sales automation
- Get started with no coding required
@@ -103,9 +94,6 @@ Vapi offers two main primitives for building voice agents, each designed for dif
iconType="solid"
href="/quickstart/web"
>
-
-
- Add voice capabilities to your web application
- Integrate voice chat into your existing product
- Build with code and SDKs
@@ -120,32 +108,19 @@ Vapi offers two main primitives for building voice agents, each designed for dif
The Vapi CLI brings the full power of the platform to your terminal:
-
-
Install in seconds with:
```bash
curl -sSL https://vapi.ai/install.sh | bash
```
Everything from the dashboard, now in your terminal.
-
Built with Assistants
Automate inbound support calls with agents that can access your knowledge base and escalate to humans when needed.
@@ -168,12 +140,9 @@ The Vapi CLI brings the full power of the platform to your terminal:
title="Sales & Lead Qualification"
icon="phone-office"
iconType="solid"
- href="/workflows/examples/lead-qualification"
+ href="/assistants/examples/lead-qualification"
>
-
-
- Built with Workflows
+ Built with Assistants
Make outbound sales calls, qualify leads, and schedule appointments with sophisticated branching logic.
@@ -181,12 +150,9 @@ The Vapi CLI brings the full power of the platform to your terminal:
title="Appointment Scheduling"
icon="calendar-check"
iconType="solid"
- href="/workflows/examples/appointment-scheduling"
+ href="/assistants/examples/appointment-scheduling"
>
-
-
- Built with Workflows
+ Built with Assistants
Handle booking requests, check availability, and confirm appointments with conditional routing.
@@ -194,12 +160,9 @@ The Vapi CLI brings the full power of the platform to your terminal:
title="Medical Triage & Scheduling"
icon="stethoscope"
iconType="solid"
- href="/workflows/examples/clinic-triage-scheduling"
+ href="/squads/examples/clinic-triage-scheduling"
>
-
-
- Built with Workflows
+ Built with Squads
Emergency routing and appointment scheduling for healthcare.
@@ -207,12 +170,9 @@ The Vapi CLI brings the full power of the platform to your terminal:
title="E-commerce Order Management"
icon="shopping-cart"
iconType="solid"
- href="/workflows/examples/ecommerce-order-management"
+ href="/squads/examples/ecommerce-order-management"
>
-
-
- Built with Workflows
+ Built with Squads
Order tracking, returns, and customer support workflows.
@@ -222,9 +182,6 @@ The Vapi CLI brings the full power of the platform to your terminal:
iconType="solid"
href="/examples"
>
-
-
See our collection of examples covering a wide range of use cases.
assistantId or a minimal assistant, then enrich context asynchronously after the call starts using Live Call Control.
+ - Host your webhook close to us-west-2 to reduce latency, and target < ~6s to allow for network jitter.
+assistantId, assistant, squadId, and squad are ignored.
+ You must still respond within 7.5 seconds.
+ To transfer silently, set destination.message to an empty string.
+ For caller ID behavior, see Call features.
+ 
+
+
+You can create different types of authentication credentials:
+
+- **Bearer Token**: Simple token-based authentication
+- **OAuth 2.0**: OAuth 2.0 client credentials flow
+- **HMAC**: HMAC signature-based authentication
+
+## Authentication Types
+
+### Bearer Token Authentication
+
+The most common authentication method using a bearer token in the Authorization header.
+
+
+
+
+#### Standard Authorization Header
+
+The most common Bearer Token configuration uses the standard `Authorization` header with the Bearer prefix:
+
+
+
+
+### OAuth 2.0 Authentication
+
+For OAuth 2.0 protected endpoints, configure client credentials flow with automatic token refresh.
+
+
+
+
+#### OAuth 2.0 Flow
+
+1. Vapi makes a token request to your OAuth endpoint with client credentials
+2. Your server validates the credentials and returns an access token
+3. Vapi includes the access token in the Authorization header for webhook requests
+4. When tokens expire, Vapi automatically requests new ones
-The simplest way to authenticate webhook requests is using a secret token. Vapi will include this token in the `X-Vapi-Signature` header of each request.
+#### Token Response Format
-#### Configuration
+Your OAuth server should return:
```json
+{
+ "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ "token_type": "Bearer",
+ "expires_in": 3600
+}
+```
+
+### HMAC Authentication
+
+For maximum security, use HMAC signature-based authentication to verify request integrity.
+
+
+
+
+## Using Credentials
+
+### In Assistant Configuration
+
+Reference credentials in your assistant's server configuration:
+
+
+
+
+### In Phone Number Configuration
+
+Assign credentials to phone numbers for incoming call authentication:
+
+
+
-For OAuth2-protected webhook endpoints, you can configure OAuth2 credentials that Vapi will use to obtain and refresh access tokens.
+### In Tool Configuration
-#### Configuration (at the assistant-level)
+Secure your function tool endpoints with credentials:
-```json
+
+
+
+### Best Practices
+
+
-
+## Common Use Cases
-#### OAuth2 Flow
+### Single Credential for Multiple Resources
-1. Vapi makes a request to your token endpoint with client credentials (Content-Type `application/x-www-form-urlencoded`)
-2. Your server validates the credentials and returns an access token
-3. Vapi includes the access token in the Authorization header for webhook requests
-4. Your server validates the access token before processing the webhook
-5. When the token expires, Vapi automatically requests a new one
+Reuse the same credential across different components:
+
+
+
+ 
+
+
+ Your credential is now ready to use with encrypted tool arguments.
+ 
+
+
+
+ 
+
+ tool-calls messages that your frontend can handle.
+model.tools array and subscribe to clientMessages: ['tool-calls'].
+3. Listen for message.type === 'tool-calls' and perform the desired UI update. No response is sent back to the model.
+4. (Optional) Inject context mid-call using vapi.addMessage(...).
+
+## Complete example (React + Web SDK)
+
+```tsx
+import Vapi from '@vapi-ai/web';
+import { useCallback, useState } from 'react';
+
+const vapi = new Vapi('
+ {notification && (
+
+ );
+}
+
+export default App;
+```
+
+## Inject data during the call
+
+Use
+ {notification}
+
+ )}
+
+
+
+ + Vapi Client Tool Calls +
+ ++ Start a call and ask the assistant to trigger UI updates +
+ +
+
+
+
+
+ addMessage to provide extra context mid-call. This does not return results for a tool; it adds messages the model can see.
+
+```ts
+// Inject system-level context
+vapi.addMessage({
+ role: 'system',
+ content: 'Context: userId=123, plan=premium, theme=dark',
+});
+
+// Inject a user message
+vapi.addMessage({
+ role: 'user',
+ content: 'FYI: I switched to the settings tab.',
+});
+```
+
+clientMessages: ['tool-calls'] and handle message.type === 'tool-calls'.
+- **Add context**: Use vapi.addMessage to inject data mid-call.
+
+## Next steps
+
+- **Server-based tools**: Learn how to return results back to the model with Custom Tools.
+- **API reference**: See Tools API for full configuration options.
diff --git a/fern/tools/code-tool.mdx b/fern/tools/code-tool.mdx
new file mode 100644
index 000000000..5bc4c397f
--- /dev/null
+++ b/fern/tools/code-tool.mdx
@@ -0,0 +1,281 @@
+---
+title: Code Tool
+subtitle: Execute custom TypeScript code directly within your assistant without setting up a server.
+slug: tools/code-tool
+---
+
+The Code Tool allows you to write and execute custom TypeScript code that runs when your assistant needs to perform a specific action. Unlike custom function tools that require you to host a server, code tools run directly on Vapi's infrastructure.
+
+## When to Use Code Tools
+
+Code tools are ideal when you need to:
+- Transform or process data during a conversation
+- Make HTTP requests to external APIs
+- Perform calculations or business logic
+- Avoid the overhead of setting up and maintaining a webhook server
+
+## Creating a Code Tool
+
+Create code tools using the [Vapi API](/api-reference/tools/create). Each code tool requires:
+
+- **Tool Name**: A descriptive identifier (e.g., `get_customer_data`)
+- **Description**: Explain what your tool does - this helps the AI understand when to use it
+- **TypeScript Code**: Write the code that will execute when the tool is called
+- **Parameters**: Define the input parameters your code expects
+- **Environment Variables**: Store sensitive values like API keys securely
+
+### Writing Your Code
+
+Your code has access to two objects:
+- **`args`**: Contains the parameters passed by the assistant
+- **`env`**: Contains your environment variables
+
+```typescript
+// Access parameters from the assistant
+const { customerId, orderType } = args;
+
+// Access secure environment variables
+const { API_KEY, API_URL } = env;
+
+// Make HTTP requests to external services
+const response = await fetch(`${API_URL}/customers/${customerId}`, {
+ headers: {
+ 'Authorization': `Bearer ${API_KEY}`,
+ 'Content-Type': 'application/json'
+ }
+});
+
+const customer = await response.json();
+
+// Return data to the assistant
+return {
+ name: customer.name,
+ email: customer.email,
+ memberSince: customer.createdAt
+};
+```
+
+
+