Skip to content
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -214,5 +214,5 @@ If none of the above resolves your issue, gather the following information and c
Now that you can troubleshoot SIP trunk credential errors:

- **Review SIP trunk setup:** Follow the complete [SIP trunking](/advanced/sip/sip-trunk) guide to verify your configuration end-to-end
- **Configure a provider:** Set up your SIP trunk with a specific provider such as [Twilio](/advanced/sip/sip-twilio), [Telnyx](/advanced/sip/sip-telnyx), [Zadarma](/advanced/sip/sip-zadarma), or [Plivo](/advanced/sip/sip-plivo)
- **Learn about SIP telephony:** Explore the [SIP telephony](/advanced/sip/sip) overview for broader SIP integration options
- **Configure a provider:** Set up your SIP trunk with a specific provider such as [Twilio](/advanced/sip/twilio), [Telnyx](/advanced/sip/telnyx), [Zadarma](/advanced/sip/zadarma), or [Plivo](/advanced/sip/plivo)
- **Learn about SIP telephony:** Explore the [SIP telephony](/advanced/sip) overview for broader SIP integration options
2 changes: 1 addition & 1 deletion fern/assistants/examples/docs-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You'll learn to:
## Prerequisites

- [Vapi account](https://dashboard.vapi.ai/) with API access
- Documentation content - `llms.txt` file ([example](https://docs.vapi.ai/llms.txt)) could work great; it could be available out-of-box with your documentation framework (e.g. [Fern](https://buildwithfern.com/learn/docs/developer-tools/llms-txt), [Mintlify](https://mintlify.com/docs/ai-ingestion#%2Fllms-full-txt))
- Documentation content - `llms.txt` file ([example](https://docs.vapi.ai/llms.txt)) could work great; it could be available out-of-box with your documentation framework (e.g. [Fern](https://buildwithfern.com/learn/docs/ai-features/llms-txt), [Mintlify](https://mintlify.com/docs/ai-ingestion#%2Fllms-full-txt))
- [LlamaCloud account](https://cloud.llamaindex.ai/) for indexing

## Get started
Expand Down
4 changes: 2 additions & 2 deletions fern/assistants/examples/inbound-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -978,9 +978,9 @@ Just like that, you've built a 24/7 customer support hotline that can handle inb

Consider the reading the following guides to further enhance your assistant:

* [**Knowledge Bases**](../knowledge-base/) - Learn more about knowledge bases to build knowledge-based agents.
* [**Knowledge Bases**](/knowledge-base) - Learn more about knowledge bases to build knowledge-based agents.
* [**External Integrations**](../tools/) - Configure integrations with [Google Calendar](../tools/google-calendar), [Google Sheets](../tools/google-sheets), [Slack](../tools/slack), etc.
* [**Squads**](../squads) - Learn how to compose multiple assistants and transfer seamlessly for complex use cases.
* [**Squads**](/squads) - Learn how to compose multiple assistants and transfer seamlessly for complex use cases.

<Callout>
Need help? Chat with the team on our [Discord](https://discord.com/invite/pUFNcf2WmH) or mention us on [X/Twitter](https://x.com/Vapi_AI).
Expand Down
2 changes: 1 addition & 1 deletion fern/assistants/model-intelligence/understanding-cost.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: assistants/model-intelligence/understanding-cost
The cost to run a voice agent mainly depends on the costs of the transcriber, LLM, and voice. Each component uses a different billing unit, so we've made some assumptions in order to provide a way for you to compare estimated cost per minute.

<Note>
The Cost number within **Performance Metrics** provide estimates for comparison rather than exact quotes. Use them to compare models consistently and understand what affects cost. See [Vapi pricing](/pricing) for current pricing. For contracted customers, certain pricing may depend on your agreement, please contact your account team for contract-specific rates.
The Cost number within **Performance Metrics** provide estimates for comparison rather than exact quotes. Use them to compare models consistently and understand what affects cost. See [Vapi pricing](https://vapi.ai/pricing) for current pricing. For contracted customers, certain pricing may depend on your agreement, please contact your account team for contract-specific rates.
</Note>

## Key concepts
Expand Down
2 changes: 1 addition & 1 deletion fern/calls/call-ended-reason.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Common transcriber error patterns:
- `call.in-progress.error-warm-transfer-silence-timeout` — Silence timeout during a warm transfer.
- `call.in-progress.error-warm-transfer-microphone-timeout` — Microphone timeout during a warm transfer.

For step-by-step transfer debugging, see [Debug forwarding drops](/calls/troubleshoot-call-forwarding-drops).
For step-by-step transfer debugging, see [Debug forwarding drops](/phone-calling/in-call-control/transfer-calls/debug-forwarding-drops).

## Transport and connectivity

Expand Down
4 changes: 2 additions & 2 deletions fern/calls/troubleshoot-call-errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ To prevent provider outages from killing your calls, configure fallback provider

For response-class guidance and checks across Vapi, your SIP provider, and your SIP infrastructure, see [Troubleshoot SIP response codes](/advanced/sip/troubleshoot-sip-response-codes).

For a detailed transfer debugging walkthrough, see [Debug forwarding drops](/calls/troubleshoot-call-forwarding-drops).
For a detailed transfer debugging walkthrough, see [Debug forwarding drops](/phone-calling/in-call-control/transfer-calls/debug-forwarding-drops).

## Call ended normally

Expand All @@ -267,7 +267,7 @@ These are not errors — they indicate the call ended as expected.

- **[Call end reasons](/calls/call-ended-reason):** Complete reference of every `endedReason` code.
- **[Debugging voice agents](/debugging):** General debugging workflow using dashboard tools, logs, and test suites.
- **[Debug forwarding drops](/calls/troubleshoot-call-forwarding-drops):** Deep dive into transfer failures.
- **[Debug forwarding drops](/phone-calling/in-call-control/transfer-calls/debug-forwarding-drops):** Deep dive into transfer failures.
- **[Troubleshoot SIP trunk errors](/advanced/sip/troubleshoot-sip-trunk-credential-errors):** Resolve SIP credential validation failures.
- **[Troubleshoot SIP response codes](/advanced/sip/troubleshoot-sip-response-codes):** Identify where a SIP request failed and what to check next.
- **[How to report issues](/issue-reporting):** Include your `call_id` and account email when contacting support.
4 changes: 2 additions & 2 deletions fern/cli/mcp-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -387,8 +387,8 @@ Now that MCP is configured:

- **[Create assistants](/quickstart/phone):** Build your first voice AI
- **[Test webhooks locally](/cli/webhook):** Debug webhooks with tunneling services
- **[Manage resources](/cli/overview#common-commands):** Use CLI commands
- **[Manage resources](/cli#common-commands):** Use CLI commands

---

**Pro tip:** After setting up MCP, try asking your IDE to "Create a complete Vapi voice assistant with error handling and logging" - watch it generate production-ready code with all the right patterns!
**Pro tip:** After setting up MCP, try asking your IDE to "Create a complete Vapi voice assistant with error handling and logging" - watch it generate production-ready code with all the right patterns!
2 changes: 1 addition & 1 deletion fern/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -283,4 +283,4 @@ Now that you know how Composer works:
- **[Assistants quickstart](/assistants/quickstart):** Learn the fundamentals of building voice agents manually
- **[Prompting guide](/prompting-guide):** Write effective system prompts for your agents
- **[Tools overview](/tools):** Understand the tools and integrations available to your agents
- **[Phone numbers](/phone-numbers/free-telephony):** Set up phone numbers for your agents
- **[Phone numbers](/free-telephony):** Set up phone numbers for your agents
4 changes: 2 additions & 2 deletions fern/customization/custom-llm/using-your-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Log in to your Vapi account and navigate to the "Model" section.
Choose the "Custom LLM" option to set up the integration.

**3. Enter Ngrok URL:**
Paste the public URL generated by ngrok (e.g., https://your-unique-id.ngrok.io) into the endpoint field. This will be the URL Vapi uses to communicate with your local server.
Paste the public URL generated by ngrok (for example, `https://your-unique-id.ngrok.io`) into the endpoint field. This will be the URL Vapi uses to communicate with your local server.

**4. Test the Connection:**
Send a test message through the Vapi interface to ensure it reaches your local server and receives a response from the OpenAI API. Verify that the response is displayed correctly in Vapi.
Expand Down Expand Up @@ -134,4 +134,4 @@ By following these detailed steps and understanding the communication flow, you
width="100%"
height="400px"
allowfullscreen
/>
/>
2 changes: 1 addition & 1 deletion fern/customization/voice-pipeline-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ To use Assembly's turn detection, set Assembly as your transcriber provider and
- **Use cases:** Healthcare, Mental Health Support, Sales & Consulting, Legal & Insurance
- **Behavior:** Holds the floor longer, optimized for reflective or complex speech

For detailed information about how Assembly's turn detection works, see the [AssemblyAI Turn Detection documentation](https://www.assemblyai.com/docs/speech-to-text/universal-streaming/turn-detection).
For detailed information about how Assembly's turn detection works, see the [AssemblyAI Turn Detection documentation](https://www.assemblyai.com/docs/universal-streaming/turn-detection).

### Wait seconds

Expand Down
6 changes: 3 additions & 3 deletions fern/knowledge-base/knowledge-base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ slug: knowledge-base

## **What is Vapi's Knowledge Base?**

A [**Knowledge Base**](/api-reference/knowledge-bases/create) is a collection of custom files that contain information on specific topics or domains. By integrating a Knowledge Base into your AI assistant, you can enable it to provide more accurate and informative responses to user queries based on your own data. Knowledge Bases are available through both the Vapi API and dashboard.
A **Knowledge Base** is a collection of custom files that contain information on specific topics or domains. By integrating a Knowledge Base into your AI assistant, you can enable it to provide more accurate and informative responses to user queries based on your own data. Knowledge Bases are available through both the Vapi API and dashboard.

### **Why Use a Knowledge Base?**

Expand All @@ -34,8 +34,8 @@ Using a Knowledge Base with your AI assistant offers several benefits:

<Info>
Knowledge Bases are configured through the API or dashboard. For advanced
configuration options, view all configurable properties in the [API
Reference](/api-reference/knowledge-bases/using-query-tool).
configuration options, see [Using the Query Tool for Knowledge
Bases](/knowledge-base/using-query-tool).
</Info>

## **How to Create a Knowledge Base**
Expand Down
4 changes: 2 additions & 2 deletions fern/observability/evals-advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1051,7 +1051,7 @@ Build up complexity gradually:

**Resources:**

- [Eval API Reference](/api-reference/eval/create)
- [Eval API Reference](/api-reference/eval/eval-controller-create)
- [Discord Community](https://discord.gg/pUFNcf2WmH) - #testing channel
- [Support](mailto:support@vapi.ai) - Include eval run ID

Expand Down Expand Up @@ -1081,7 +1081,7 @@ Build up complexity gradually:
<Card
title="Eval API reference"
icon="book"
href="/api-reference/eval/create"
href="/api-reference/eval/eval-controller-create"
>
Complete API documentation for evaluations
</Card>
Expand Down
8 changes: 4 additions & 4 deletions fern/observability/evals-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ curl -X POST "https://api.vapi.ai/eval" \

Save the returned `id` - you'll need it to run the evaluation.

For complete API details, see [Create Eval](/api-reference/eval/create).
For complete API details, see [Create Eval](/api-reference/eval/eval-controller-create).

</Tab>
</Tabs>
Expand Down Expand Up @@ -374,7 +374,7 @@ curl -X POST "https://api.vapi.ai/eval" \
}'
```

For API details, see [Create Eval](/api-reference/eval/create).
For API details, see [Create Eval](/api-reference/eval/eval-controller-create).

</Tab>
</Tabs>
Expand Down Expand Up @@ -919,7 +919,7 @@ curl -X POST "https://api.vapi.ai/eval" \
}'
```

For API details, see [Create Eval](/api-reference/eval/create).
For API details, see [Create Eval](/api-reference/eval/eval-controller-create).

</Tab>
</Tabs>
Expand Down Expand Up @@ -1388,7 +1388,7 @@ Run multiple evals sequentially to validate all greeting scenarios.
<Card
title="Eval API reference"
icon="book"
href="/api-reference/eval/create"
href="/api-reference/eval/eval-controller-create"
>
Complete API documentation for evals
</Card>
Expand Down
6 changes: 3 additions & 3 deletions fern/observability/monitoring-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -596,11 +596,11 @@ curl -X PATCH "https://api.vapi.ai/monitoring/issue/e5f6a7b8-c9d0-1234-efab-5678

<CardGroup cols={2}>
<Card
title="Advanced monitoring"
title="Schedule-based triggers"
icon="chart-line"
href="/observability/monitoring-advanced"
href="#schedule-based-triggers"
>
Configure schedule-based triggers, multi-threshold monitors, and compliance monitoring
Configure monitors that evaluate on recurring intervals
</Card>

<Card
Expand Down
2 changes: 1 addition & 1 deletion fern/providers/observability/langfuse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Vapi natively integrates with Langfuse, allowing you to send traces directly to

## What is Langfuse?

[Langfuse](https://langfuse.com/) is an open source LLM engineering platform designed to provide better **[observability](/docs/tracing)** and **[evaluations](/docs/scores/overview)** into AI applications. It helps developers track, analyze, and visualize traces from AI interactions, enabling better performance tuning, debugging, and optimization of AI agents.
[Langfuse](https://langfuse.com/) is an open source LLM engineering platform designed to provide better **[observability](https://langfuse.com/docs/observability/overview)** and **[evaluations](https://langfuse.com/docs/evaluation/scores/overview)** into AI applications. It helps developers track, analyze, and visualize traces from AI interactions, enabling better performance tuning, debugging, and optimization of AI agents.

## Get Started

Expand Down
2 changes: 1 addition & 1 deletion fern/resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ slug: resources
<tr><td>Client Examples</td><td><a target="_blank" href="https://github.com/VapiAI/client-side-example-javascript-next">Next.js</a> · <a target="_blank" href="https://github.com/VapiAI/client-side-example-javascript-react">React</a> · <a target="_blank" href="https://github.com/VapiAI/flutter/tree/main/example">Flutter</a> · <a target="_blank" href="https://github.com/VapiAI/client-side-example-react-native">React Native</a></td></tr>
<tr><td>Server Examples</td><td><a target="_blank" href="https://github.com/VapiAI/server-side-example-serverless-vercel">Vercel</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-serverless-cloudflare">Cloudflare</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-serverless-supabase">Supabase</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-javascript-node">Node</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-javascript-bun">Bun</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-javascript-deno">Deno</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-python-flask">Flask</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-php-laravel">Laravel</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-go-gin">Go</a> · <a target="_blank" href="https://github.com/VapiAI/server-side-example-rust-actix">Rust</a></td></tr>
<tr><td>Resources</td><td><a target="_blank" href="https://docs.vapi.ai/">Official Docs</a> · <a target="_blank" href="https://api.vapi.ai/api">API Reference</a> · <a href="/sdk/mcp-server">MCP Server</a> </td></tr>
<tr><td>Community</td><td><a target="_blank" href="/community/videos">Videos</a> . <a target="_blank" href="https://www.vapiblocks.com/">UI Library</a></td></tr>
<tr><td>Community</td><td><a target="_blank" href="https://vapi.ai/library">Videos</a> . <a target="_blank" href="https://www.vapiblocks.com/">UI Library</a></td></tr>
</tbody>
</table>
2 changes: 1 addition & 1 deletion fern/security-and-privacy/data-flow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -418,5 +418,5 @@ Even with maximum custom configuration, certain data passes through Vapi's orche

### Compliance
- [HIPAA Compliance](/security-and-privacy/hipaa) - Healthcare data handling
- [PCI Compliance](/security-and-privacy/PCI) - Payment data handling
- [PCI Compliance](/security-and-privacy/pci) - Payment data handling
- [GDPR Compliance](/security-and-privacy/GDPR) - EU data protection
2 changes: 1 addition & 1 deletion fern/security-and-privacy/hipaa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ When HIPAA mode is enabled, Vapi does not store structured outputs by default. T
Under the Business Associate Agreement (BAA), you agree:
1. Not to introduce PHI onto Vapi's platform through its API or dashboard except as permitted
2. To use HIPAA-compliant accounts with external providers when providing keys
3. To only use HIPAA-compliant providers that Vapi has signed a BAA with when not providing keys. See [HIPAA compliant providers](/security-and-privacy/hipaa-providers) for the current list.
3. To only use HIPAA-compliant providers that Vapi has signed a BAA with when not providing keys. See [HIPAA compliant providers](#hipaa-compliant-providers) for the current list.
4. To use the platform in accordance with all BAA requirements
</Accordion>
</AccordionGroup>
Expand Down
4 changes: 2 additions & 2 deletions fern/security-and-privacy/recording-consent-plan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ When users decline recording consent, you can configure different actions using

For detailed information about these tools, see:

- **[Handoff Tool](/tools/handoff)** - Transfer to other assistants
- **[Handoff Tool](/squads/handoff)** - Transfer to other assistants
- **[Default Tools](/tools/default-tools)** - Transfer calls and end calls

## Best Practices
Expand Down Expand Up @@ -324,6 +324,6 @@ For detailed information about these tools, see:
## Next Steps

- **[Call Recording](/assistants/call-recording)** - Learn about technical recording implementation
- **[Handoff Tool](/tools/handoff)** - Transfer between assistants
- **[Handoff Tool](/squads/handoff)** - Transfer between assistants
- **[Default Tools](/tools/default-tools)** - Transfer calls and end calls
- **[API Reference](/api-reference/assistants/create)** - Explore assistant configuration options
2 changes: 1 addition & 1 deletion fern/server-url/setting-server-urls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Here's a breakdown of where you can set server URLs in Vapi:
<Accordion title="Via the API" icon="code" iconType="solid">
The server URL for phone numbers can be set **3 ways**:
- **At Time of Creation:** when you [create a free number](/api-reference/phone-numbers/create) through Vapi
- **At Import:** when you [import from Twilio](/api-reference/phone-numbers/import-twilio-number) or [Vonage](/api-reference/phone-numbers/import-vonage-number)
- **At Import:** when you [import from Twilio](/api-reference/phone-numbers/import-twilio-number) or create a [Vonage phone number](/api-reference/phone-numbers/create)
- **Via Update:** you can [update a number](/api-reference/phone-numbers/update-phone-number) already in your account

The phone number's server configuration includes both the URL and optional authentication:
Expand Down
Loading
Loading