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
6 changes: 3 additions & 3 deletions fern/advanced/sip/sip-chime.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This integration does not support passing custom SIP headers, metadata, or enric
## Prerequisites

- An AWS account with access to the [Amazon Chime SDK console](https://console.aws.amazon.com/chime-sdk/)
- A Vapi account with a private API key
- A Vapi account with a [private API key](/security-and-privacy/api-keys)
- AWS CLI configured, or access to the Chime SDK console
- A phone number provisioned in Amazon Chime SDK (or the ability to order one)
- A Vapi assistant already created (for inbound calls)
Expand Down Expand Up @@ -93,9 +93,9 @@ If you don't have any phone numbers in your inventory, order them from **Amazon

<Steps>

<Step title="Retrieve your Vapi API key">
<Step title="Get your Vapi API key">

Log in to your [Vapi dashboard](https://dashboard.vapi.ai) and retrieve your API key from the **Organization Settings**.
Get a [Vapi API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.

</Step>

Expand Down
8 changes: 4 additions & 4 deletions fern/advanced/sip/sip-plivo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ Indian phone numbers cannot be used with Plivo on Vapi due to TRAI regulations.

## Vapi Configuration
<Steps>
<Step title="Get Your Vapi API Key">
Sign in to the dashboard and [get your API key](https://dashboard.vapi.ai/org/api-keys).
<Step title="Get your Vapi API key">
Get a [Vapi API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.
</Step>
<Step title="Create a SIP Trunk Credential">
1. Copy the following API call.
Expand Down Expand Up @@ -222,8 +222,8 @@ Indian phone numbers cannot be used with Plivo on Vapi due to TRAI regulations.

## Vapi Configuration
<Steps>
<Step title="Get Your Vapi API Key">
Sign into the dashboard and [get your api key](https://dashboard.vapi.ai/org/api-keys).
<Step title="Get your Vapi API key">
Get a [Vapi API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.
</Step>
<Step title="Create an Inbound SIP Trunk Credential">
```bash
Expand Down
8 changes: 1 addition & 7 deletions fern/advanced/sip/sip-telnyx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ Integrate your Telnyx SIP trunk with Vapi to enable your AI voice assistants to

<Steps>
<Step title="Retrieve your Vapi private key">
<Steps>
<Step title="Get your private key">
- Log in to your Vapi account
- Navigate to **Organization Settings**
- In the **API Keys** section, copy your **Private Key**
</Step>
</Steps>
Get a [Vapi private API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.
</Step>

<Step title="Configure Telnyx for inbound calls">
Expand Down
4 changes: 2 additions & 2 deletions fern/advanced/sip/sip-twilio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ This guide walks you through setting up both outbound and inbound SIP trunking b

### Vapi Configuration

1. **Retrieve Your Vapi API Key**
1. **Get your Vapi API key**

Log in to your Vapi.ai account and retrieve your API key from the Organization Settings.
Get a [Vapi API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.

2. **Create a SIP Trunk Credential**

Expand Down
6 changes: 2 additions & 4 deletions fern/advanced/sip/sip-zadarma.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ slug: advanced/sip/zadarma

Integrate your Zadarma SIP trunk with Vapi.ai to enable your AI voice assistants to handle calls efficiently. Follow the steps below to set up this integration:

## 1. Retrieve Your Vapi.ai Private Key
## 1. Get your Vapi private API key

- Log in to your Vapi.ai account.
- Navigate to **Organization Settings**.
- In the **API Keys** section, copy your **Private Key**.
Get a [Vapi private API key](/security-and-privacy/api-keys) to authenticate the API requests in this guide.

## 2. Add Your Zadarma SIP Credentials to Vapi.ai

Expand Down
3 changes: 1 addition & 2 deletions fern/assistants/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Create a voice assistant with a simple prompt, attach a phone number, and make y

## Prerequisites

- A Vapi account and API key
- A Vapi account and a [Vapi API key](/security-and-privacy/api-keys)

## 1) Create an assistant

Expand Down Expand Up @@ -99,4 +99,3 @@ By default, when you create an assistant, the transcriber, model, and voice are
- **Use a preset**: [Model Intelligence presets](/assistants/model-intelligence/presets) bundle a transcriber, model, and voice tuned for common use cases, so you can configure your assistant in one click.
- **Structure data**: [Structured outputs](/assistants/structured-outputs)
- **Move to multi-assistant**: [Squads](/squads)

8 changes: 3 additions & 5 deletions fern/assistants/retrieve-call-artifacts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,15 @@ Some private storage URLs contain `hipaa-recordings` in the path. That's an inte

Call recordings and logs are stored in a private bucket. These URLs aren't directly downloadable.

To retrieve a recording or log file, call the Vapi API with your **Private API Key**. The API responds with a `302` redirect to a short-lived, authenticated download URL.
To retrieve a recording or log file, call the Vapi API with a [Vapi private API key](/security-and-privacy/api-keys). The API responds with a `302` redirect to a short-lived, authenticated download URL.

<Warning>
Never expose your Private API Key in client-side code or commit it to version control. Store it as a secret in your backend environment.
</Warning>

## Get your Private API Key
## Get your private API key

1. Open the [Vapi Dashboard](https://dashboard.vapi.ai/).
2. Go to **Manage** → **API Keys**.
3. Copy the value of your **Private API Key**.
Follow the [Vapi API key guide](/security-and-privacy/api-keys) to create, view, or copy a private key.

## Integration

Expand Down
2 changes: 1 addition & 1 deletion fern/assistants/structured-outputs-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ A customer support assistant that automatically extracts:
Sign up at [dashboard.vapi.ai](https://dashboard.vapi.ai)
</Card>
<Card title="API key" icon="key">
Get your API key from **API Keys** on sidebar
Get a [Vapi API key](/security-and-privacy/api-keys)
</Card>
</CardGroup>

Expand Down
4 changes: 2 additions & 2 deletions fern/calls/call-queue-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This approach is ideal for call centers, customer support lines, or any applicat

Before implementing call queue management, ensure you have:

- **Vapi Account**: Access to the [Vapi Dashboard](https://dashboard.vapi.ai/org/api-keys) with your API key
- **Vapi Account**: Access to the [Vapi Dashboard](https://dashboard.vapi.ai/) with a [Vapi API key](/security-and-privacy/api-keys)
- **Twilio Account**: Active Twilio account with Account SID and Auth Token
- **Twilio CLI**: Install from [twil.io/cli](https://twil.io/cli) for queue management
- **Phone Number**: Twilio phone number configured for incoming calls
Expand Down Expand Up @@ -708,4 +708,4 @@ Now that you have a production-ready call queue system with Redis persistence an

<Tip>
Consider implementing health checks, metrics collection, and alerting around your Redis counters and queue processing latency for production monitoring.
</Tip>
</Tip>
10 changes: 2 additions & 8 deletions fern/chat/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,8 @@ We'll create a customer support chat for "TechFlow", a software company that wan
## 1. Get Your API Credentials

<Steps>
<Step title="Open the Vapi Dashboard">
Go to [dashboard.vapi.ai](https://dashboard.vapi.ai) and log in to your account.
</Step>
<Step title="Navigate to API Keys">
Click on your profile in the top right, then select `Vapi API Keys`.
</Step>
<Step title="Copy your API key">
Copy your Private API Key. You'll need this for all chat requests.
<Step title="Get your Vapi private API key">
Follow the [Vapi API key guide](/security-and-privacy/api-keys) to create, view, or copy a private key. Use this key to authenticate server-side chat requests.

<Warning>
Keep this key secure - never expose it in client-side code.
Expand Down
16 changes: 5 additions & 11 deletions fern/chat/web-widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ View the complete source code and examples on [GitHub](https://github.com/VapiAI

## Prerequisites

* A [Vapi account](https://dashboard.vapi.ai/) with a public API key
* A [Vapi account](https://dashboard.vapi.ai/) with a [public API key](/security-and-privacy/api-keys)
* An existing assistant or willingness to create one
* A website where you want to embed the widget

Expand All @@ -38,14 +38,8 @@ We'll add a customer support widget to "TechFlow's" website that allows visitors
## 1. Get Your Public API Key

<Steps>
<Step title="Open the Vapi Dashboard">
Go to [dashboard.vapi.ai](https://dashboard.vapi.ai) and log in to your account.
</Step>
<Step title="Navigate to API Keys">
Click on your profile in the top right, then select `Vapi API Keys`.
</Step>
<Step title="Copy your Public API Key">
Copy your **Public API Key**. This is safe to use in client-side code.
<Step title="Get your Vapi public API key">
Follow the [Vapi API key guide](/security-and-privacy/api-keys) to create, view, or copy a public key.

<Note>
Unlike private keys, public keys are safe to expose in your website code.
Expand Down Expand Up @@ -459,7 +453,7 @@ You must provide either `assistant-id`, `assistant`, or both `assistant-id` and

* Microphone access for voice mode
* HTTPS required in production
* Vapi account and API key
* Vapi account and [API key](/security-and-privacy/api-keys)

## Next Steps

Expand All @@ -476,4 +470,4 @@ The widget automatically handles microphone permissions, audio processing, and c

<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).
</Callout>
</Callout>
6 changes: 3 additions & 3 deletions fern/cli/project-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ After initialization, configure your environment:
```
</Step>

<Step title="Add your API key">
Get your API key from the [Vapi Dashboard](https://dashboard.vapi.ai/):
<Step title="Add your Vapi API key">
Follow the [Vapi API key guide](/security-and-privacy/api-keys) to create, view, or copy an API key:
```bash
VAPI_API_KEY=your-api-key-here
```
Expand Down Expand Up @@ -348,4 +348,4 @@ Next steps:
2. Add your VAPI_API_KEY
3. Run: npm run dev
4. Test the voice button at http://localhost:3000
```
```
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,8 @@ navigation:
contents:
- page: Data flow
path: security-and-privacy/data-flow.mdx
- page: API keys
path: security-and-privacy/api-keys.mdx
- page: Single Sign-On (SSO)
path: security-and-privacy/sso.mdx
- page: JWT authentication
Expand Down
2 changes: 1 addition & 1 deletion fern/observability/evals-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ An evaluation suite for an appointment booking assistant that tests:
Sign up at [dashboard.vapi.ai](https://dashboard.vapi.ai)
</Card>
<Card title="API key" icon="key">
Get your API key from **API Keys** in sidebar
Get a [Vapi API key](/security-and-privacy/api-keys)
</Card>
</CardGroup>

Expand Down
2 changes: 1 addition & 1 deletion fern/observability/monitoring-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ In this quickstart, you will create a monitor that tracks error rates across you
Sign up at [dashboard.vapi.ai](https://dashboard.vapi.ai)
</Card>
<Card title="API key" icon="key">
Get your API key from **API Keys** in the sidebar
Get a [Vapi API key](/security-and-privacy/api-keys)
</Card>
</CardGroup>

Expand Down
12 changes: 7 additions & 5 deletions fern/observability/scorecard-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ A scorecard that:

## Prerequisites

<Note>
You need: A Vapi account and API key, an assistant with a model and voice
configured, structured outputs created and attached that your scorecard will
use
</Note>
You need:

- A Vapi account
- A [Vapi API key](/security-and-privacy/api-keys)
- An assistant with a model and voice configured
- Structured outputs created and attached for the scorecard to use

<Warning>
Metrics can only reference structured outputs of type number/integer or boolean.
</Warning>
Expand Down
2 changes: 1 addition & 1 deletion fern/observability/simulations-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ A simulation suite for an appointment booking assistant that tests:
Sign up at [dashboard.vapi.ai](https://dashboard.vapi.ai)
</Card>
<Card title="API key" icon="key">
Get your API key from **API Keys** in sidebar
Get a [Vapi API key](/security-and-privacy/api-keys)
</Card>
</CardGroup>

Expand Down
6 changes: 3 additions & 3 deletions fern/providers/chat-dash.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ subtitle: ChatDash is a white-label dashboard platform that integrates with Vapi
slug: providers/chat-dash
---

[ChatDash](https://bit.ly/3NJpkM7) is a white-label client dashboard platform designed for AI agent agencies. Our seamless integration with Vapi is engineered for simplicity—just enter your Vapi Agent ID and API Key, and your dashboard is up instantly with real-time analytics, detailed call logs, and comprehensive Stripe billing integration.
[ChatDash](https://bit.ly/3NJpkM7) is a white-label client dashboard platform designed for AI agent agencies. Our seamless integration with Vapi is engineered for simplicity—just enter your Vapi Agent ID and [Vapi API key](/security-and-privacy/api-keys), and your dashboard is up instantly with real-time analytics, detailed call logs, and comprehensive Stripe billing integration.

## Key Benefits

- **Quick Setup:**
Simply input your Vapi Agent ID and API Key, and ChatDash instantly pulls in data to configure your dashboard.
Simply input your Vapi Agent ID and [Vapi API key](/security-and-privacy/api-keys), and ChatDash instantly pulls in data to configure your dashboard.

- **Instant Analytics & Call Logs:**
Gain immediate access to real-time analytics and detailed call logs from your Vapi agent, so you can monitor performance as soon as you're set up.
Expand All @@ -23,7 +23,7 @@ slug: providers/chat-dash
## How It Works

1. **Enter Your Credentials:**
Provide your Vapi Agent ID and API Key in ChatDash.
Provide your Vapi Agent ID and [Vapi API key](/security-and-privacy/api-keys) in ChatDash.

2. **Dashboard Setup:**
ChatDash automatically configures your dashboard with live analytics and call logs.
Expand Down
4 changes: 2 additions & 2 deletions fern/providers/klen-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Klen AI is a cutting-edge white-label platform that leverages Vapi to empower ag
## Key Benefits

- **White-label Voice Platform:** Build and deploy voice agents under your own brand with complete control over your domain and aesthetics.
- **Partner-Specific API Key Support:** Integrate your personal Vapi API keys for tailored control and direct billing oversight.
- **Partner-Specific API Key Support:** Integrate your personal [Vapi API keys](/security-and-privacy/api-keys) for tailored control and direct billing oversight.
- **Managed Infrastructure:** Enjoy robust webhook integration, secure authentication, and a scalable multi-tenant architecture.
- **Advanced Scheduling & Campaign Management:** Leverage intelligent scheduling, bi-directional calendar sync, and automated outbound campaigns.
- **Team Collaboration:** Benefit from multi-user access, shared AI agents, and role-based permissions to streamline operations.
Expand Down Expand Up @@ -38,7 +38,7 @@ Ready to transform your voice AI offerings?
1. [Sign up for a Klen AI account](https://klen.ai/get-started)
2. Choose the partner plan that suits your agency's needs.
3. Configure your white-label settings and domain.
4. Connect your Vapi API key (or use our platform key).
4. Connect your [Vapi API key](/security-and-privacy/api-keys) (or use our platform key).
5. Start building and deploying custom voice agents today.

## Learn More
Expand Down
2 changes: 1 addition & 1 deletion fern/providers/transcriber/soniox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Configure Soniox in the Vapi Dashboard or update an assistant through the API.
</Steps>
</Tab>
<Tab title="cURL">
Set `VAPI_API_KEY` in your environment, then replace `YOUR_ASSISTANT_ID` with the assistant ID.
Set `VAPI_API_KEY` in your environment with a [Vapi API key](/security-and-privacy/api-keys), then replace `YOUR_ASSISTANT_ID` with the assistant ID.

```bash
curl -X PATCH "https://api.vapi.ai/assistant/YOUR_ASSISTANT_ID" \
Expand Down
2 changes: 1 addition & 1 deletion fern/providers/vapify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Vapify is a white-label platform for Vapi that simplifies how agencies sell and

## Key Benefits
- **Seamless Integration:**
Seamlessly integrate Vapify with your Vapi setup. To get started, all you need is a Vapi key - zero coding required.
Seamlessly integrate Vapify with your Vapi setup. To get started, all you need is a [Vapi API key](/security-and-privacy/api-keys) - zero coding required.
- **Comprehensive Analytics:**
Get access to detailed call logs, recordings, and client-ready reporting.
- **White-Label Experience:**
Expand Down
4 changes: 2 additions & 2 deletions fern/providers/voiceaiwrapper.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ VoiceAIWrapper is the ultimate white-label platform built specifically for Vapi
## Key Benefits

- **30-Minute Setup:**
Connect your Vapi API key and instantly sync all assistants, phone numbers, and knowledge bases. No coding required—just paste your credentials and start onboarding clients.
Connect your [Vapi API key](/security-and-privacy/api-keys) and instantly sync all assistants, phone numbers, and knowledge bases. No coding required—just paste your credentials and start onboarding clients.

- **Complete White-Labeling:**
Your domain, your logo, your colors, your support channels. Clients never see VoiceAIWrapper branding—it's your platform powered by our infrastructure.
Expand All @@ -31,7 +31,7 @@ VoiceAIWrapper is the ultimate white-label platform built specifically for Vapi
## How It Works

1. **Connect Your Vapi Account:**
Add your Vapi API key and organization ID. VoiceAIWrapper automatically syncs all assistants, phone numbers, and configurations.
Add your [Vapi API key](/security-and-privacy/api-keys) and organization ID. VoiceAIWrapper automatically syncs all assistants, phone numbers, and configurations.

2. **Brand Your Platform:**
Upload your logo, connect your domain, and configure your Stripe keys for automated billing under your brand.
Expand Down
4 changes: 2 additions & 2 deletions fern/providers/voicerr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Key pillars:
| Voicerr Advantage | What It Means for You |
|-------------------|-----------------------|
| Instant white-label portal | Launch a branded site, logo, and domain in minutes. |
| Deep Vapi sync | Assistants, numbers, and recordings pulled with one API key. |
| Deep Vapi sync | Assistants, numbers, and recordings pulled with one [API key](/security-and-privacy/api-keys). |
| Automated Stripe billing | Invoices, payments, and markup handled for you. |
| Growth tools included | Lead Finder, outbound calls, and multi-step workflows. |
| Unlimited scale | One flat price whether you serve 1 client or 1000. |
Expand All @@ -37,7 +37,7 @@ By branding Voicerr you can **whitelabel AI voice agents** for every client whil

## How It Works

1. **Connect Vapi** – Paste your Organization ID and Private Key; Voicerr syncs assistants, numbers, and minutes instantly.
1. **Connect Vapi** – Paste your Organization ID and [Private Key](/security-and-privacy/api-keys); Voicerr syncs assistants, numbers, and minutes instantly.
2. **Brand & price** – Upload your logo, map a custom domain, and create plans with your desired markup.
3. **Onboard clients** – Add clients manually or let them self-sign-up; choose exactly what each client can see or edit.
4. **Scale & automate** – Use Lead Finder to gather prospects, trigger Batch Calling campaigns, and wire everything together with Automation Lab workflows.
Expand Down
2 changes: 1 addition & 1 deletion fern/quickstart/phone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Vapi makes it easy to build voice agents that can make and receive phone calls.
## Prerequisites

- [A Vapi account](https://dashboard.vapi.ai)
- For SDK usage: API key from the Dashboard
- For SDK usage: [Vapi API key](/security-and-privacy/api-keys) from the Dashboard

<Tip>
**Using the Vapi CLI?** You can create assistants, manage phone numbers, and make calls directly from your terminal:
Expand Down
2 changes: 1 addition & 1 deletion fern/sdk/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This automatically configures Cursor, Windsurf, or VSCode with the Vapi MCP serv

<Steps>
<Step title="Get your Vapi API key">
[Get your API key from the Vapi dashboard.](https://dashboard.vapi.ai/org/api-keys)
Follow the [Vapi API key guide](/security-and-privacy/api-keys) to create, view, or copy an API key.
</Step>
<Step title="Edit Claude Desktop config">
Open <b>Settings</b> → <b>Developer</b> tab → <b>Edit Config</b>.
Expand Down
Loading
Loading