diff --git a/fern/GHL.mdx b/fern/GHL.mdx
index 1cd63534d..90e0e5165 100644
--- a/fern/GHL.mdx
+++ b/fern/GHL.mdx
@@ -1,6 +1,6 @@
---
title: How to Connect Vapi with Make & GHL
-slug: GHL
+slug: tools/GHL
---
diff --git a/fern/assistants.mdx b/fern/assistants.mdx
index 4bd17482d..115942388 100644
--- a/fern/assistants.mdx
+++ b/fern/assistants.mdx
@@ -4,10 +4,58 @@ subtitle: The core building-block of voice agents on Vapi.
slug: assistants
---
+**Assistant** is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and
+experience for call centers, business websites, mobile apps, and much more.
-**Assistant** is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and experience for call centers, business websites, mobile apps, and much more.
+## Core Components
-There are three core components: **Transcriber**, **Model**, and **Voice**. These can be configured, mixed, and matched for your use case.
There are also various other configurable properties you can find [here](/api-reference/assistants/create-assistant) Below, check out some ways you can layer in powerful customizations and features to meet any use case.
+There are three core components that make up an assistant:
+
+- **Transcriber**: Converts spoken audio into text
+- **Model**: The AI model that processes the text and generates responses
+- **Voice**: The voice that speaks the AI's responses
+
+These components can be configured, mixed, and matched for your specific use case.
+
+
+ View all configurable properties in the [API Reference](/api-reference/assistants/create-assistant)
+
+
+## Key Features
+
+### Dynamic Variables
+Personalize your assistant's responses using variables that can be customized for each call. This allows you to:
+- Insert dynamic content like dates, times, and user information
+- Customize greetings and responses
+- Maintain context across conversations
+
+### Call Analysis
+Get detailed insights into each conversation through:
+- Call summaries
+- Structured data extraction
+- Success evaluation metrics
+- Custom analysis rubrics
+
+### Persistence Options
+Choose between:
+- **Persistent Assistants**: Reusable configurations stored via the `/assistant` endpoint
+- **Temporary Assistants**: One-time configurations specified when starting a call
+
+## Prompting Best Practices
+
+Effective prompt engineering is crucial for creating successful voice AI agents. Learn how to:
+- Structure prompts for voice interactions
+- Add personality and natural speech patterns
+- Handle errors gracefully
+- Improve response quality
+
+
+ Learn best practices for engineering voice AI prompts
+
## Advanced Concepts
diff --git a/fern/docs.yml b/fern/docs.yml
index 2139c573d..f90eea167 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -49,8 +49,9 @@ navbar-links:
- type: minimal
text: Status
href: https://status.vapi.ai/
- - type: minimal
+ - type: outlined
text: Support
+ rightIcon: fa-solid fa-headset
href: /support
- type: filled
text: Dashboard
@@ -88,66 +89,26 @@ analytics:
navigation:
- tab: documentation
layout:
- - page: Introduction
- path: introduction.mdx
- - section: General
+ - section: Getting Started
contents:
+ - page: Introduction
+ path: introduction.mdx
- section: How Vapi Works
contents:
- page: Core Models
path: quickstart.mdx
- page: Orchestration Models
path: how-vapi-works.mdx
- - section: Billing
- contents:
- - page: Billing Overview
- path: pricing.mdx
- - page: Cost Routing
- path: billing/cost-routing.mdx
- - page: Billing FAQ
- path: billing/billing-faq.mdx
- - page: Billing Limits
- path: billing/billing-limits.mdx
- - page: Estimating Costs
- path: billing/estimating-costs.mdx
- - page: Billing Examples
- path: billing/examples.mdx
- - section: Enterprise
- contents:
- - page: Vapi Enterprise
- path: enterprise/plans.mdx
- - page: On-Prem Deployments
- path: enterprise/onprem.mdx
- - page: HIPAA Compliance
- path: security-and-privacy/hipaa.mdx
- - page: PCI Compliance
- path: security-and-privacy/PCI.mdx
- - link: SOC-2 Compliance
- href: https://security.vapi.ai/
- - page: Support
- path: support.mdx
- - link: Status
- href: https://status.vapi.ai/
- - section: Quickstart
- contents:
- page: Dashboard
path: quickstart/dashboard.mdx
- - page: Inbound Calling
- path: quickstart/inbound.mdx
- - page: Outbound Calling
- path: quickstart/outbound.mdx
- - page: Web Calling
- path: quickstart/web.mdx
- - section: Client SDKs
+ - section: Making Calls
contents:
- - page: Overview
- path: sdks.mdx
- - page: Web SDK
- path: sdk/web.mdx
- - page: Web Snippet
- path: examples/voice-widget.mdx
- - page: Server SDKs
- path: server-sdks.mdx
+ - page: Inbound Calling
+ path: quickstart/inbound.mdx
+ - page: Outbound Calling
+ path: quickstart/outbound.mdx
+ - page: Web Calling
+ path: quickstart/web.mdx
- section: Examples
contents:
- page: Outbound Sales
@@ -158,20 +119,14 @@ navigation:
path: examples/pizza-website.mdx
- page: Python Outbound Snippet
path: examples/outbound-call-python.mdx
- - page: Code Resources
- path: resources.mdx
- section: Core Concepts
contents:
- - page: Prompting Guide
- path: prompting-guide.mdx
- section: Assistants
contents:
- page: Introduction
path: assistants.mdx
- - page: Default Tools
- path: assistants/function-calling.mdx
- - page: Custom Tools
- path: assistants/custom-tools.mdx
+ - page: Voice AI Prompting Guide
+ path: prompting-guide.mdx
- page: Persistent Assistants
path: assistants/persistent-assistants.mdx
- page: Dynamic Variables
@@ -190,26 +145,38 @@ navigation:
path: blocks/steps.mdx
- page: Block Types
path: blocks/block-types.mdx
- - section: Knowledge Base
+ - section: Calls
contents:
- page: Introduction
- path: knowledge-base/knowledge-base.mdx
- - page: Integrating with Trieve
- path: knowledge-base/integrating-with-trieve.mdx
- - section: Server URL
+ path: phone-calling.mdx
+ - page: Call Forwarding
+ path: call-forwarding.mdx
+ - page: Dynamic Call Transfers
+ path: calls/call-dynamic-transfers.mdx
+ - page: Ended Reason
+ path: calls/call-ended-reason.mdx
+ - page: Live Call Control
+ path: calls/call-features.mdx
+ - page: On-Hold Specialist Transfer
+ path: calls/call-handling-with-vapi-and-twilio.mdx
+ - page: Voice Mail Detection
+ path: calls/voice-mail-detection.mdx
+ - section: Tools
contents:
- page: Introduction
- path: server-url.mdx
- - page: Setting Server URLs
- path: server-url/setting-server-urls.mdx
- - page: Server Events
- path: server-url/events.mdx
- - page: Developing Locally
- path: server-url/developing-locally.mdx
- - section: Phone Calling
+ path: tools/introduction.mdx
+ - page: Default Tools
+ path: tools/default-tools.mdx
+ - page: Custom Tools
+ path: tools/custom-tools.mdx
+ - page: Make & GHL Tools
+ path: GHL.mdx
+ - section: Knowledge Base
contents:
- page: Introduction
- path: phone-calling.mdx
+ path: knowledge-base/knowledge-base.mdx
+ - page: Integrating with Trieve
+ path: knowledge-base/integrating-with-trieve.mdx
- section: Squads
contents:
- page: Introduction
@@ -220,68 +187,110 @@ navigation:
path: squads/silent-transfers.mdx
- section: Advanced Concepts
contents:
- - section: Calls
+ - section: Vapi SDKs
contents:
- - page: Call Forwarding
- path: call-forwarding.mdx
- - page: Dynamic Call Transfers
- path: calls/call-dynamic-transfers.mdx
- - page: Ended Reason
- path: calls/call-ended-reason.mdx
- - page: Live Call Control
- path: calls/call-features.mdx
- - page: On-Hold Specialist Transfer
- path: calls/call-handling-with-vapi-and-twilio.mdx
- - page: Voice Mail Detection
- path: calls/voice-mail-detection.mdx
- - section: SIP
+ - page: Overview
+ path: sdks.mdx
+ - section: Client SDKs
+ contents:
+ - page: Web SDK
+ path: sdk/web.mdx
+ - page: Web Snippet
+ path: examples/voice-widget.mdx
+ - page: Server SDKs
+ path: server-sdks.mdx
+ - page: Code Resources
+ path: resources.mdx
+ - section: Server URLs
+ contents:
+ - page: Introduction
+ path: server-url.mdx
+ - page: Setting Server URLs
+ path: server-url/setting-server-urls.mdx
+ - page: Server Events
+ path: server-url/events.mdx
+ - page: Developing Locally
+ path: server-url/developing-locally.mdx
+ - section: SIP Telephony
contents:
- page: SIP Introduction
path: advanced/sip/sip.mdx
- page: Telnyx Integration
path: advanced/sip/sip-telnyx.mdx
- - page: Make & GHL Integration
- path: GHL.mdx
- - page: Voice Fallback Plan
- path: voice-fallback-plan.mdx
- - page: OpenAI Realtime
- path: openai-realtime.mdx
- - section: Customization
- contents:
- - page: Provider Keys
- path: customization/provider-keys.mdx
- - section: Custom LLM
+ - page: Multilingual Support
+ path: customization/multilingual.mdx
+ - section: Advanced Voice Features
contents:
- - page: Fine-tuned OpenAI models
- path: customization/custom-llm/fine-tuned-openai-models.mdx
- - page: Custom LLM
- path: customization/custom-llm/using-your-server.mdx
- - page: Custom LLM Tool Calling Integration
- path: customization/custom-llm/tool-calling-integration.mdx
- - section: Custom Voices
+ - page: Speech Configuration
+ path: customization/speech-configuration.mdx
+ - page: Voice Fallback Plan
+ path: voice-fallback-plan.mdx
+ - page: OpenAI Realtime Speech-to-Speech
+ path: openai-realtime.mdx
+ - section: Customization
contents:
- - page: Introduction
- path: customization/custom-voices/custom-voice.mdx
- - page: Elevenlabs
- path: customization/custom-voices/elevenlabs.mdx
- - page: PlayHT
- path: customization/custom-voices/playht.mdx
- - page: Tavus
- path: customization/custom-voices/tavus.mdx
- - page: Custom Keywords
- path: customization/custom-keywords.mdx
- - page: Multilingual
- path: customization/multilingual.mdx
- - page: JWT Authentication
- path: customization/jwt-authentication.mdx
- - page: Speech Configuration
- path: customization/speech-configuration.mdx
+ - page: Provider Keys
+ path: customization/provider-keys.mdx
+ - section: Custom LLM
+ contents:
+ - page: Fine-tuned OpenAI models
+ path: customization/custom-llm/fine-tuned-openai-models.mdx
+ - page: Custom LLM
+ path: customization/custom-llm/using-your-server.mdx
+ - page: Custom LLM Tool Calling Integration
+ path: customization/custom-llm/tool-calling-integration.mdx
+ - section: Custom Voices
+ contents:
+ - page: Introduction
+ path: customization/custom-voices/custom-voice.mdx
+ - page: Elevenlabs
+ path: customization/custom-voices/elevenlabs.mdx
+ - page: PlayHT
+ path: customization/custom-voices/playht.mdx
+ - page: Tavus
+ path: customization/custom-voices/tavus.mdx
+ - page: Custom Keywords
+ path: customization/custom-keywords.mdx
+ - page: JWT Authentication
+ path: customization/jwt-authentication.mdx
- section: Glossary
contents:
- page: Definitions
path: glossary.mdx
- page: FAQ
path: faq.mdx
+ - section: Platform
+ contents:
+ - page: Support
+ path: support.mdx
+ - section: Billing
+ contents:
+ - page: Billing Overview
+ path: pricing.mdx
+ - page: Cost Routing
+ path: billing/cost-routing.mdx
+ - page: Billing FAQ
+ path: billing/billing-faq.mdx
+ - page: Billing Limits
+ path: billing/billing-limits.mdx
+ - page: Estimating Costs
+ path: billing/estimating-costs.mdx
+ - page: Billing Examples
+ path: billing/examples.mdx
+ - section: Enterprise
+ contents:
+ - page: Vapi Enterprise
+ path: enterprise/plans.mdx
+ - page: On-Prem Deployments
+ path: enterprise/onprem.mdx
+ - page: HIPAA Compliance
+ path: security-and-privacy/hipaa.mdx
+ - page: PCI Compliance
+ path: security-and-privacy/PCI.mdx
+ - link: SOC-2 Compliance
+ href: https://security.vapi.ai/
+ - link: Status
+ href: https://status.vapi.ai/
- section: Community
contents:
- section: Videos
@@ -316,15 +325,13 @@ navigation:
path: community/television.mdx
- page: Usecase
path: community/usecase.mdx
- - page: My Vapi
- path: community/myvapi.mdx
- page: Expert Directory
path: community/expert-directory.mdx
- link: Discord
href: https://discord.com/invite/pUFNcf2WmH
- - section: Providers
+ - section: Providers on Vapi
contents:
- - section: Voice
+ - section: Voices (Text-to-Speech)
contents:
- page: ElevenLabs
path: providers/voice/elevenlabs.mdx
@@ -344,11 +351,11 @@ navigation:
path: providers/voice/rimeai.mdx
- page: Deepgram
path: providers/voice/deepgram.mdx
- - section: Video
- contents:
- - page: Tavus
- path: providers/video/tavus.mdx
- - section: Models
+ - section: Video Models
+ contents:
+ - page: Tavus
+ path: providers/video/tavus.mdx
+ - section: Large Language Models
contents:
- page: OpenAI
path: providers/model/openai.mdx
@@ -364,7 +371,7 @@ navigation:
path: providers/model/togetherai.mdx
- page: OpenRouter
path: providers/model/openrouter.mdx
- - section: Transcription
+ - section: Transcribers (Speech-to-Text)
contents:
- page: Deepgram
path: providers/transcriber/deepgram.mdx
@@ -576,3 +583,11 @@ redirects:
destination: "/knowledge-base/integrating-with-trieve"
- source: "/quickstart/billing"
destination: "/billing/billing-faq"
+ - source: /assistants/default-tools
+ destination: /tools/default-tools
+ - source: /assistants/function-calling
+ destination: /tools/default-tools
+ - source: /assistants/custom-tools
+ destination: /tools/custom-tools
+ - source: /GHL
+ destination: /tools/GHL
diff --git a/fern/prompting-guide.mdx b/fern/prompting-guide.mdx
index 65a1cb39b..af1b75229 100644
--- a/fern/prompting-guide.mdx
+++ b/fern/prompting-guide.mdx
@@ -1,5 +1,5 @@
---
-title: Prompting Guide
+title: Voice AI Prompting Guide
slug: prompting-guide
---
diff --git a/fern/assistants/custom-tools.mdx b/fern/tools/custom-tools.mdx
similarity index 99%
rename from fern/assistants/custom-tools.mdx
rename to fern/tools/custom-tools.mdx
index 85c517f77..896922457 100644
--- a/fern/assistants/custom-tools.mdx
+++ b/fern/tools/custom-tools.mdx
@@ -1,7 +1,7 @@
---
title: Custom Tools
subtitle: Learn how to create and configure Custom Tools for use by your Vapi assistants.
-slug: assistants/custom-tools
+slug: tools/custom-tools
---
diff --git a/fern/assistants/function-calling.mdx b/fern/tools/default-tools.mdx
similarity index 99%
rename from fern/assistants/function-calling.mdx
rename to fern/tools/default-tools.mdx
index 706e2949a..2aac076ac 100644
--- a/fern/assistants/function-calling.mdx
+++ b/fern/tools/default-tools.mdx
@@ -1,7 +1,7 @@
---
title: Default Tools
subtitle: 'Adding Transfer Call, End Call, and Dial Keypad capabilities to your assistants.'
-slug: assistants/default-tools
+slug: tools/default-tools
---
Vapi voice assistants are given additional functions: `transferCall`,`endCall`, and `dtmf` (to dial a keypad with [DTMF](https://en.wikipedia.org/wiki/DTMF)). These functions can be used to transfer calls, hang up calls, and enter digits on the keypad.
diff --git a/fern/tools/introduction.mdx b/fern/tools/introduction.mdx
new file mode 100644
index 000000000..6c96b52a4
--- /dev/null
+++ b/fern/tools/introduction.mdx
@@ -0,0 +1,107 @@
+---
+title: Introduction
+subtitle: Extend your assistant's capabilities with powerful function calling tools.
+slug: tools
+---
+
+**Tools** 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.
+
+There are three types of tools available:
+
+1. **Default Tools**: Built-in functions provided by Vapi for common operations like call transfers and control.
+2. **Custom Tools**: Your own functions that can be called by the assistant to interact with your systems.
+3. **Integration Tools**: Pre-built integrations with platforms like [Make](https://www.make.com/en/integrations/vapi) and GoHighLevel (GHL) that let you trigger automated workflows via voice.
+
+
+ Tools are configured as part of your assistant's model configuration. You can find the complete API reference [here](/api-reference/assistants/create-assistant).
+
+
+## Available Tools
+
+
+
+ Built-in tools for call control, transfers, and basic operations
+
+
+ Create your own tools to extend assistant capabilities
+
+
+ Import Make scenarios and GHL workflows as voice-activated tools
+
+
+
+## Integration Tools
+
+With Make and GHL integrations, you can:
+- Import existing Make scenarios and GHL workflows directly into Vapi
+- Trigger automated workflows using voice commands
+- Connect your voice AI to hundreds of apps and services
+- Automate complex business processes through voice interaction
+
+Common use cases include:
+- Booking appointments via voice
+- Updating CRM records during calls
+- Triggering email or SMS follow-ups
+- Processing orders and payments
+- Managing customer support tickets
+
+## Key Features
+
+
+
+ Assistants can trigger functions based on conversation context
+
+
+ Tools can run synchronously or asynchronously
+
+
+ Connect tools to your backend via webhooks
+
+
+ Built-in error handling and fallback options
+
+
+
+## Learn More
+
+
+
+ Learn how to import and use Make scenarios and GHL workflows as voice-activated tools
+
+
+ Get help with tool integrations from our community
+
+
\ No newline at end of file