diff --git a/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx b/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx index 4921db80f..4447932a9 100644 --- a/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx +++ b/fern/advanced/sip/troubleshoot-sip-trunk-credential-errors.mdx @@ -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 diff --git a/fern/assistants/examples/docs-agent.mdx b/fern/assistants/examples/docs-agent.mdx index 60fe88040..50bc9de79 100644 --- a/fern/assistants/examples/docs-agent.mdx +++ b/fern/assistants/examples/docs-agent.mdx @@ -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 diff --git a/fern/assistants/examples/inbound-support.mdx b/fern/assistants/examples/inbound-support.mdx index e9c934946..7ee43619c 100644 --- a/fern/assistants/examples/inbound-support.mdx +++ b/fern/assistants/examples/inbound-support.mdx @@ -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. 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). diff --git a/fern/assistants/model-intelligence/understanding-cost.mdx b/fern/assistants/model-intelligence/understanding-cost.mdx index ab0fd8a79..1aa8d4092 100644 --- a/fern/assistants/model-intelligence/understanding-cost.mdx +++ b/fern/assistants/model-intelligence/understanding-cost.mdx @@ -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. -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. ## Key concepts diff --git a/fern/calls/call-ended-reason.mdx b/fern/calls/call-ended-reason.mdx index 4349eb71e..db4e4cc0f 100644 --- a/fern/calls/call-ended-reason.mdx +++ b/fern/calls/call-ended-reason.mdx @@ -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 diff --git a/fern/calls/troubleshoot-call-errors.mdx b/fern/calls/troubleshoot-call-errors.mdx index 4a144cab6..d4cd6f2c4 100644 --- a/fern/calls/troubleshoot-call-errors.mdx +++ b/fern/calls/troubleshoot-call-errors.mdx @@ -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 @@ -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. diff --git a/fern/cli/mcp-integration.mdx b/fern/cli/mcp-integration.mdx index d5dd5ed22..38aaeb580 100644 --- a/fern/cli/mcp-integration.mdx +++ b/fern/cli/mcp-integration.mdx @@ -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! \ No newline at end of file +**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! diff --git a/fern/composer.mdx b/fern/composer.mdx index d55277c0e..5b7105d5c 100644 --- a/fern/composer.mdx +++ b/fern/composer.mdx @@ -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 diff --git a/fern/customization/custom-llm/using-your-server.mdx b/fern/customization/custom-llm/using-your-server.mdx index 4f5bb6ef9..65e25a5cf 100644 --- a/fern/customization/custom-llm/using-your-server.mdx +++ b/fern/customization/custom-llm/using-your-server.mdx @@ -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. @@ -134,4 +134,4 @@ By following these detailed steps and understanding the communication flow, you width="100%" height="400px" allowfullscreen - /> \ No newline at end of file + /> diff --git a/fern/customization/voice-pipeline-configuration.mdx b/fern/customization/voice-pipeline-configuration.mdx index d3a3bb4d6..a06792eec 100644 --- a/fern/customization/voice-pipeline-configuration.mdx +++ b/fern/customization/voice-pipeline-configuration.mdx @@ -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 diff --git a/fern/knowledge-base/knowledge-base.mdx b/fern/knowledge-base/knowledge-base.mdx index e600a6a0c..43e85ada4 100644 --- a/fern/knowledge-base/knowledge-base.mdx +++ b/fern/knowledge-base/knowledge-base.mdx @@ -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?** @@ -34,8 +34,8 @@ Using a Knowledge Base with your AI assistant offers several benefits: 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). ## **How to Create a Knowledge Base** diff --git a/fern/observability/evals-advanced.mdx b/fern/observability/evals-advanced.mdx index e3fbdcb09..ce7eadbd8 100644 --- a/fern/observability/evals-advanced.mdx +++ b/fern/observability/evals-advanced.mdx @@ -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 @@ -1081,7 +1081,7 @@ Build up complexity gradually: Complete API documentation for evaluations diff --git a/fern/observability/evals-quickstart.mdx b/fern/observability/evals-quickstart.mdx index 47d9a0a33..2ad8cf07c 100644 --- a/fern/observability/evals-quickstart.mdx +++ b/fern/observability/evals-quickstart.mdx @@ -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). @@ -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). @@ -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). @@ -1388,7 +1388,7 @@ Run multiple evals sequentially to validate all greeting scenarios. Complete API documentation for evals diff --git a/fern/observability/monitoring-quickstart.mdx b/fern/observability/monitoring-quickstart.mdx index 63ef4496a..74c1894ea 100644 --- a/fern/observability/monitoring-quickstart.mdx +++ b/fern/observability/monitoring-quickstart.mdx @@ -596,11 +596,11 @@ curl -X PATCH "https://api.vapi.ai/monitoring/issue/e5f6a7b8-c9d0-1234-efab-5678 - Configure schedule-based triggers, multi-threshold monitors, and compliance monitoring + Configure monitors that evaluate on recurring intervals Client ExamplesNext.js · React · Flutter · React Native Server ExamplesVercel · Cloudflare · Supabase · Node · Bun · Deno · Flask · Laravel · Go · Rust ResourcesOfficial Docs · API Reference · MCP Server -CommunityVideos . UI Library +CommunityVideos . UI Library diff --git a/fern/security-and-privacy/data-flow.mdx b/fern/security-and-privacy/data-flow.mdx index c56d57614..fc0d6da6e 100644 --- a/fern/security-and-privacy/data-flow.mdx +++ b/fern/security-and-privacy/data-flow.mdx @@ -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 diff --git a/fern/security-and-privacy/hipaa.mdx b/fern/security-and-privacy/hipaa.mdx index 9b5fd2145..740b15729 100644 --- a/fern/security-and-privacy/hipaa.mdx +++ b/fern/security-and-privacy/hipaa.mdx @@ -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 diff --git a/fern/security-and-privacy/recording-consent-plan.mdx b/fern/security-and-privacy/recording-consent-plan.mdx index af096da79..0bb8d4e9b 100644 --- a/fern/security-and-privacy/recording-consent-plan.mdx +++ b/fern/security-and-privacy/recording-consent-plan.mdx @@ -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 @@ -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 diff --git a/fern/server-url/setting-server-urls.mdx b/fern/server-url/setting-server-urls.mdx index f79d43a5f..9f1569397 100644 --- a/fern/server-url/setting-server-urls.mdx +++ b/fern/server-url/setting-server-urls.mdx @@ -85,7 +85,7 @@ Here's a breakdown of where you can set server URLs in Vapi: 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: diff --git a/fern/squads.mdx b/fern/squads.mdx index d46948f6e..0692cabfc 100644 --- a/fern/squads.mdx +++ b/fern/squads.mdx @@ -25,7 +25,7 @@ To use Squads, you can create a `squad` when starting a call and specify `member The first member is the assistant that will start the call. -We recommend using [Handoff Tools](/tools/handoff) to specify which destinations the current assistant can handoff too, and when to handoff to each assistant. Each assistant within the squad can use its saved handoff tools as well as handoff tools from Assistant Overrides (see below). +We recommend using [Handoff Tools](/squads/handoff) to specify which destinations the current assistant can handoff too, and when to handoff to each assistant. Each assistant within the squad can use its saved handoff tools as well as handoff tools from Assistant Overrides (see below). ```json @@ -183,5 +183,4 @@ Note: This is `squadOverrides` for the [`assistant-request`](api-reference/webho **Define clear handoff conditions** - Write specific handoff descriptions that state exact trigger conditions and what information to collect before transferring. Make sure to specify this in the assistant's prompt and/or tool description. -**Engineer context carefully** - Use [context engineering](/tools/handoff#context-engineering) to control what conversation history is passed between assistants. As the context grows throughout the call, you may want to limit message history to reduce tokens, improve performance, and prevent context poisoning. Utilize [variable extraction](/tools/handoff#variable-extraction) to save information and generate summaries during a handoff to pass to other assistants. - +**Engineer context carefully** - Use [context engineering](/squads/handoff#context-engineering) to control what conversation history is passed between assistants. As the context grows throughout the call, you may want to limit message history to reduce tokens, improve performance, and prevent context poisoning. Utilize [variable extraction](/squads/handoff#variable-extraction) to save information and generate summaries during a handoff to pass to other assistants. diff --git a/fern/squads/examples/clinic-triage-scheduling-handoff-tool.mdx b/fern/squads/examples/clinic-triage-scheduling-handoff-tool.mdx index 870b4efae..8b97bdb13 100644 --- a/fern/squads/examples/clinic-triage-scheduling-handoff-tool.mdx +++ b/fern/squads/examples/clinic-triage-scheduling-handoff-tool.mdx @@ -202,7 +202,7 @@ Test the handoff system with different patient scenarios: Now that you have a working handoff-based clinic system: -- **Advanced Handoffs**: [Handoff Tools](/tools/handoff) +- **Advanced Handoffs**: [Handoff Tools](/squads/handoff) - **Custom Tools**: [Scheduling Tools](/tools/custom-tools) - **Calendar Integration**: [Google Calendar](/tools/google-calendar) - **Emergency Protocols**: [Call Forwarding](/call-forwarding) diff --git a/fern/tools/mcp.mdx b/fern/tools/mcp.mdx index 24606272a..e11b782fc 100644 --- a/fern/tools/mcp.mdx +++ b/fern/tools/mcp.mdx @@ -225,7 +225,7 @@ Zapier offers an MCP server that provides access to thousands of app integration Composio also offers an MCP server for integration: -1. Log in to the Composio dashboard at https://mcp.composio.dev/dashboard +1. Log in to the Composio dashboard at [dashboard.composio.dev](https://dashboard.composio.dev) 2. Select the tool you want to integrate (e.g., Gmail) 3. Enable the MCP server for the selected tool by connecting your account using authentication flow 4. Create a server and copy the generated URL diff --git a/fern/workflows/examples/property-management.mdx b/fern/workflows/examples/property-management.mdx index 96085558b..c629b0574 100644 --- a/fern/workflows/examples/property-management.mdx +++ b/fern/workflows/examples/property-management.mdx @@ -708,6 +708,6 @@ Configure time-based routing logic: You've built a sophisticated property management call routing workflow! Consider these enhancements: * **[Customer support escalation system](/assistants/examples/support-escalation)** - Explore the assistant-based approach -* **[Workflow Analytics](/workflows/analytics)** - Track routing patterns and optimize decision trees -* **[Integration Templates](/workflows/integrations)** - Connect with popular property management systems -* **[Advanced Routing](/workflows/advanced-routing)** - Implement complex routing logic with multiple conditions +* **[Workflow overview](/workflows/overview)** - Review workflow structure and routing concepts +* **[Workflow quickstart](/workflows/quickstart)** - Build and test a workflow from scratch +* **[Migrate to Squads](/workflows/legacy-migration)** - Plan a migration from legacy Workflows to Squads