docs.yml

# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json

instances:
  - url: https://vapi.docs.buildwithfern.com
    custom-domain: docs.vapi.ai
    edit-this-page:
      github:
        owner: VapiAI
        repo: docs
        branch: main

announcement:

title: Vapi
favicon: static/images/favicon.ico
logo:
  light: static/images/logo/logo-light.svg
  dark: static/images/logo/logo-dark.svg
  href: /
  height: 22
colors:
  accentPrimary:
    light: "#62F6B5"
    dark: "#62F6B5"
  background:
    light: "#FFFAEA"
    dark: "#0E0E13"
  header-background:
    light: "#FFFAEA"
    dark: "#0E0E13"
experimental:
  mdx-components:
    - snippets
landing-page:
  page: Welcome
  path: welcome.mdx
css: assets/styles.css
js:
  - path: ./assets/close-playground.js
  - path: ./assets/trieve-user-script.js
    strategy: lazyOnload
navbar-links:
  - type: minimal
    text: Website
    href: https://vapi.ai/
  - type: minimal
    text: Status
    href: https://status.vapi.ai/
  - type: outlined
    text: Support
    rightIcon: fa-solid fa-headset
    href: /support
  - type: filled
    text: Dashboard
    rightIcon: fa-solid fa-chevron-right
    href: https://dashboard.vapi.ai/
    rounded: true
footer-links:
  github: https://github.com/vapiai
  twitter: https://twitter.com/vapi_ai
  discord: https://discord.gg/pUFNcf2WmH
  website: https://vapi.ai/
  linkedin: https://www.linkedin.com/company/vapi-ai
tabs:
  api-reference:
    slug: api-reference
    icon: terminal
    display-name: API Reference
  documentation:
    display-name: Documentation
    icon: book
    slug: documentation
  changelog:
    display-name: Changelog
    slug: changelog
    changelog: ./changelog
    icon: history
layout:
  tabs-placement: header
  searchbar-placement: header
  header-height: 80px
analytics:
  posthog:
    api-key: ${POSTHOG_PROJECT_API_KEY}
    endpoint: https://us.i.posthog.com
navigation:
  - tab: documentation
    layout:
      - section: Getting Started
        collapsed: true
        contents:
          - section: Quickstart
            path: introduction.mdx
            contents:
              - page: Dashboard Quickstart
                path: quickstart/dashboard.mdx
              - page: Inbound Call Quickstart
                path: quickstart/inbound.mdx
              - page: Outbound Call Quickstart
                path: quickstart/outbound.mdx
              - page: Web Call Quickstart
                path: quickstart/web.mdx

          - section: How Vapi Works
            contents:
              - page: Core Models
                path: quickstart.mdx
              - page: Orchestration Models
                path: how-vapi-works.mdx

          - section: Use Cases
            contents:
              - page: Outbound Sales
                path: examples/outbound-sales.mdx
              - page: Inbound Support
                path: examples/inbound-support.mdx
              - page: Pizza Website
                path: examples/pizza-website.mdx
              - page: Python Outbound Snippet
                path: examples/outbound-call-python.mdx

      - section: Build
        contents:
          - section: Assistants
            path: assistants.mdx
            contents:
              - page: Voice AI Prompting Guide
                path: prompting-guide.mdx
              - page: Persistent Assistants
                path: assistants/persistent-assistants.mdx
              - page: Dynamic Variables
                path: assistants/dynamic-variables.mdx
              - page: Call Analysis
                path: assistants/call-analysis.mdx
              - page: Assistant Hooks
                path: assistants/assistant-hooks.mdx
              - page: Background Messages
                path: assistants/background-messages.mdx
              - page: Voice Formatting Plan
                path: assistants/voice-formatting-plan.mdx
              - page: Multilingual Support
                path: customization/multilingual.mdx
              - 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
              - 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: Custom Transcriber
                path: customization/custom-transcriber.mdx

          - section: Phone Numbers
            contents:
              - page: Free Telephony
                path: phone-numbers/free-telephony.mdx
              - page: SIP Telephony Guide
                path: advanced/sip/sip.mdx
              - page: SIP Trunking Guide
                path: advanced/sip/sip-trunk.mdx
              - page: Telnyx Integration
                path: advanced/sip/sip-telnyx.mdx
              - page: Zadarma Integration
                path: advanced/sip/sip-zadarma.mdx

          - section: Tools
            path: tools/introduction.mdx
            contents:
              - 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
            path: knowledge-base/knowledge-base.mdx
            contents:
              - page: Using the Query Tool
                path: knowledge-base/using-query-tool.mdx
              - page: Integrating with Trieve
                path: knowledge-base/integrating-with-trieve.mdx

          - section: Workflows
            path: workflows.mdx
            contents:
              - section: Nodes
                contents:
                  - page: Say
                    path: workflows/nodes/say.mdx
                  - page: Gather
                    path: workflows/nodes/gather.mdx
                  - page: API Request
                    path: workflows/nodes/api-request.mdx
                  - page: Transfer
                    path: workflows/nodes/transfer.mdx
                  - page: Hangup
                    path: workflows/nodes/hangup.mdx

              - section: Edges
                contents:
                  - page: Logical Conditions
                    path: workflows/edges/logical-conditions.mdx

          - section: Squads
            path: squads.mdx
            contents:
              - page: Example
                path: squads-example.mdx
              - page: Silent Transfers
                path: squads/silent-transfers.mdx

          - section: Integrations
            contents:
              - section: Voices (Text-to-Speech)
                contents:
                  - page: ElevenLabs
                    path: providers/voice/elevenlabs.mdx
                  - page: PlayHT
                    path: providers/voice/playht.mdx
                  - page: Azure
                    path: providers/voice/azure.mdx
                  - page: OpenAI
                    path: providers/voice/openai.mdx
                  - page: Neets
                    path: providers/voice/neets.mdx
                  - page: Cartesia
                    path: providers/voice/cartesia.mdx
                  - page: LMNT
                    path: providers/voice/imnt.mdx
                  - page: RimeAI
                    path: providers/voice/rimeai.mdx
                  - page: Deepgram
                    path: providers/voice/deepgram.mdx

                  - section: Video Models
                    contents:
                      - page: Tavus
                        path: providers/video/tavus.mdx

              - section: Large Language Models
                contents:
                  - page: OpenAI
                    path: providers/model/openai.mdx
                  - page: Gemini
                    path: providers/model/gemini.mdx
                  - page: Groq
                    path: providers/model/groq.mdx
                  - page: DeepInfra
                    path: providers/model/deepinfra.mdx
                  - page: Perplexity
                    path: providers/model/perplexity.mdx
                  - page: TogetherAI
                    path: providers/model/togetherai.mdx
                  - page: OpenRouter
                    path: providers/model/openrouter.mdx

              - section: Transcribers (Speech-to-Text)
                contents:
                  - page: Deepgram
                    path: providers/transcriber/deepgram.mdx
                  - page: Gladia
                    path: providers/transcriber/gladia.mdx
                  - page: Talkscriber
                    path: providers/transcriber/talkscriber.mdx
                  - page: Assembly AI
                    path: providers/transcriber/assembly-ai.mdx

              - section: Cloud
                contents:
                  - page: AWS S3
                    path: providers/cloud/s3.mdx
                  - page: GCP Cloud Storage
                    path: providers/cloud/gcp.mdx
                  - page: Cloudflare R2
                    path: providers/cloud/cloudflare.mdx
                  - page: Supabase
                    path: providers/cloud/supabase.mdx

              - section: Observability
                contents:
                  - page: Langfuse
                    path: providers/observability/langfuse.mdx

              - page: Voiceflow
                path: providers/voiceflow.mdx
              - page: ChatDash
                path: providers/chat-dash.mdx

      - section: Test
        collapsed: true
        contents:
          - page: Test Suites
            path: test/test-suites.mdx

      - section: Deploy
        collapsed: true
        contents:
          - section: Calls
            path: phone-calling.mdx
            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: Voicemail Detection
                path: calls/voicemail-detection.mdx

          - section: SDKs
            path: sdks.mdx
            contents:
              - section: Client SDKs
                contents:
                  - page: Web SDK
                    path: sdk/web.mdx
                  - page: Web Snippet
                    path: examples/voice-widget.mdx
                  - page: JWT Authentication
                    path: customization/jwt-authentication.mdx

              - page: Server SDKs
                path: server-sdks.mdx
              - page: Code Resources
                path: resources.mdx

          - section: Webhooks
            path: server-url.mdx
            contents:
              - 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: Community
        collapsed: true
        contents:
          - section: Videos
            contents:
              - page: Appointment Scheduling
                path: community/appointment-scheduling.mdx
              - page: Comparisons
                path: community/comparisons.mdx
              - page: Conferences
                path: community/conferences.mdx
              - page: Demos
                path: community/demos.mdx
              - page: GoHighLevel
                path: community/ghl.mdx
              - page: Guide
                path: community/guide.mdx
              - page: Inbound
                path: community/inbound.mdx
              - page: Knowledgebase
                path: community/knowledgebase.mdx
              - page: Outbound
                path: community/outbound.mdx
              - page: Podcast
                path: community/podcast.mdx
              - page: Snippets & SDKs Tutorials
                path: community/snippets-sdks-tutorials.mdx
              - page: Special Mentions
                path: community/special-mentions.mdx
              - page: Squads
                path: community/squads.mdx
              - page: Television
                path: community/television.mdx
              - page: Usecase
                path: community/usecase.mdx

          - page: Expert Directory
            path: community/expert-directory.mdx
          - link: Discord
            href: https://discord.com/invite/pUFNcf2WmH

      - section: Support & Billing
        collapsed: true
        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/

          - page: Glossary
            path: glossary.mdx

          - page: FAQ
            path: faq.mdx

          - link: Status Page
            href: https://status.vapi.ai/

      - section: Legal
        collapsed: true
        contents:
          - page: TCPA Consent Guidelines
            path: tcpa-consent.mdx
          - link: Privacy Policy
            href: https://vapi.ai/privacy
          - link: Terms of Service
            href: https://vapi.ai/terms-of-service

  - tab: api-reference
    layout:
      - api: API Reference
        api-name: api
        flattened: true
        skip-slug: true
        paginated: true
        snippets:
          typescript: "@vapi/server-sdk"
          python: vapi_server_sdk
          go: https://github.com/VapiAI/server-sdk-go

      - api: Webhooks
        api-name: webhooks
        paginated: true

      - section: ""
        contents:
          - link: Swagger
            href: https://api.vapi.ai/api
          - link: OpenAPI
            href: https://api.vapi.ai/api-json

  - tab: changelog

redirects:
  - source: /developer-documentation
    destination: /introduction
  - source: /documentation/general/changelog
    destination: /changelog
  - source: /api-reference/assistants/create-assistant
    destination: /api-reference/assistants/create
  - source: /api-reference/assistants/get-assistant
    destination: /api-reference/assistants/get
  - source: /api-reference/assistants/list-assistants
    destination: /api-reference/assistants/list
  - source: /api-reference/assistants/update-assistant
    destination: /api-reference/assistants/update
  - source: /api-reference/assistants/delete-assistant
    destination: /api-reference/assistants/delete
  - source: /api-reference/calls/create-call
    destination: /api-reference/calls/create
  - source: /api-reference/calls/create-phone-call
    destination: /api-reference/calls/create
  - source: /api-reference/calls/get-call
    destination: /api-reference/calls/get
  - source: /api-reference/calls/list-calls
    destination: /api-reference/calls/list
  - source: /api-reference/calls/update-call
    destination: /api-reference/calls/update
  - source: /api-reference/calls/delete-call-data
    destination: /api-reference/calls/delete
  - source: /api-reference/phone-numbers/create-phone-number
    destination: /api-reference/phone-numbers/create
  - source: /api-reference/phone-numbers/get-phone-number
    destination: /api-reference/phone-numbers/get
  - source: /api-reference/phone-numbers/list-phone-numbers
    destination: /api-reference/phone-numbers/list
  - source: /api-reference/phone-numbers/update-phone-number
    destination: /api-reference/phone-numbers/update
  - source: /api-reference/phone-numbers/delete-phone-number
    destination: /api-reference/phone-numbers/delete
  - source: /api-reference/files/upload-file
    destination: /api-reference/files/upload
  - source: /api-reference/files/get-file
    destination: /api-reference/files/get
  - source: /api-reference/files/list-files
    destination: /api-reference/files/list
  - source: /api-reference/files/update-file
    destination: /api-reference/files/update
  - source: /api-reference/files/delete-file
    destination: /api-reference/files/delete
  - source: /api-reference/squads/create-squad
    destination: /api-reference/squads/create
  - source: /api-reference/squads/get-squad
    destination: /api-reference/squads/get
  - source: /api-reference/squads/list-squads
    destination: /api-reference/squads/list
  - source: /api-reference/squads/update-squad
    destination: /api-reference/squads/update
  - source: /api-reference/squads/delete-squad
    destination: /api-reference/squads/delete
  - source: /api-reference/tools/create-tool
    destination: /api-reference/tools/create
  - source: /api-reference/tools/get-tool
    destination: /api-reference/tools/get
  - source: /api-reference/tools/list-tools
    destination: /api-reference/tools/list
  - source: /api-reference/tools/update-tool
    destination: /api-reference/tools/update
  - source: /api-reference/tools/delete-tool
    destination: /api-reference/tools/delete
  - source: /api-reference/analytics/create-analytics-queries
    destination: /api-reference/analytics/get
  - source: /api-reference/messages/server-message
    destination: /api-reference/webhooks/server-message
  - source: /api-reference/messages/server-message-response
    destination: /api-reference/webhooks/server-message
  - source: /api-reference/messages/client-message
    destination: /api-reference/webhooks/client-message
  - source: /api-reference/messages/client-inbound-message
    destination: /api-reference/webhooks/client-message
  - source: "/api-reference/phone-numbers/import-twilio-number"
    destination: "/api-reference/phone-numbers/create-phone-number"
  - source: "api-reference/calls/create-call"
    destination: "https://api.vapi.ai/api#/Calls/CallController_create"
  - source: "/getting_started"
    destination: "/quickstart/dashboard"
  - source: "/dashboard"
    destination: "/quickstart/dashboard"
  - source: "/provider_keys"
    destination: "/assistants/provider-keys"
  - source: "/provider-keys"
    destination: "/assistants/provider-keys"
  - source: "/custom_llm"
    destination: "/assistants/custom-llm"
  - source: "/custom-llm"
    destination: "/assistants/custom-llm"
  - source: "/custom_voice"
    destination: "/assistants/custom-voice"
  - source: "/custom-voice"
    destination: "/assistants/custom-voice"
  - source: "/function_calling"
    destination: "/assistants/function-calling"
  - source: "/function-calling"
    destination: "/assistants/function-calling"
  - source: "/persistent_assistants"
    destination: "/assistants/persistent-assistants"
  - source: "/persistent-assistants"
    destination: "/assistants/persistent-assistants"
  - source: "/dynamic_variables"
    destination: "/assistants/dynamic-variables"
  - source: "/dynamic-variables"
    destination: "/assistants/dynamic-variables"
  - source: "/call_analysis"
    destination: "/assistants/call-analysis"
  - source: "/call-analysis"
    destination: "/assistants/call-analysis"
  - source: "/text_message"
    destination: "/assistants/background-messages"
  - source: "/text-message"
    destination: "/assistants/background-messages"
  - source: "/privacy_hipaa"
    destination: "/enterprise/hipaa"
  - source: "/server_url"
    destination: "/server-url"
  - source: "/phone_calling"
    destination: "/phone-calling"
  - source: "/multilingual_support"
    destination: "/multilingual"
  - source: "/multilingual/introduction"
    destination: "/multilingual"
  - source: "/outbound_sales"
    destination: "/examples/outbound-sales"
  - source: "/technical_support"
    destination: "/examples/inbound-support"
  - source: "/pizza_website"
    destination: "/examples/pizza-website"
  - source: "/outbound_call_python"
    destination: "/examples/outbound-call-python"
  - source: "/voice_widget"
    destination: "/voice-widget"
  - source: "/clients"
    destination: "/sdks"
  - source: "/error_message_guide"
    destination: "/calls/call-ended-reason"
  - source: "/privacy"
    destination: "/privacy-policy"
  - source: "/call_forwarding"
    destination: "/call-forwarding"
  - source: "/prompting_guide"
    destination: "/prompting-guide"
  - source: "/community/videos"
    destination: "/community/appointment-scheduling"
  - source: "/enterprise"
    destination: "/enterprise/plans"
  - source: "/tools-calling"
    destination: "/assistants/custom-tools"
  - source: "/knowledgebase"
    destination: "/knowledge-base"
  - source: "/customization/bring-your-own-vectors/trieve"
    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
  - source: /phone-calling/voice-mail-detection
    destination: /phone-calling/voicemail-detection