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
10 changes: 5 additions & 5 deletions fern/assistants/structured-outputs-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Define what information you want to extract using a [JSON Schema](https://json-s
<Step title="Navigate to Structured Outputs">
1. Log in to [dashboard.vapi.ai](https://dashboard.vapi.ai)
2. Click on **Structured Outputs** in the left sidebar
3. Click **Create New Structured Output**
3. Click **Create Structured Output**
</Step>

<Step title="Configure Basic Settings">
Expand Down Expand Up @@ -138,7 +138,7 @@ Define what information you want to extract using a [JSON Schema](https://json-s
</Step>

<Step title="Save and Attach">
1. Click **Create Structured Output**
1. Click **Save**
2. In the structured output dialog, you can directly attach it to an assistant
3. Select an existing assistant to attach this output to that assistant
</Step>
Expand Down Expand Up @@ -405,8 +405,8 @@ You can create an assistant via the Dashboard or API, then use its ID in the exa
<Steps>
<Step title="Start a test call">
1. Navigate to your assistant (from **Assistants** in the sidebar)
2. Ensure your structured output is attached in the **Artifact Plan** section
3. Click **Talk to Assistant** in the top right corner
2. On the **Tools** tab, ensure your structured output is attached in the **Structured Outputs** section
3. Select **Talk** in the top-right corner
4. The assistant will start speaking
</Step>

Expand Down Expand Up @@ -697,7 +697,7 @@ Enable storage for these types of non-sensitive outputs:
<Tab title="Dashboard">
1. Navigate to **Structured Outputs** in the left sidebar
2. Create or edit a structured output
3. Expand the **Compliance Settings** section
3. Open the **Settings** tab and go to **Compliance**
4. Enable the toggle for "Enable Storage of Structured Outputs while on HIPAA Mode"
5. **Recommendation**: Only enable if your output does not extract sensitive information
</Tab>
Expand Down
8 changes: 4 additions & 4 deletions fern/assistants/versioning/traffic-splitting.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Traffic splitting
subtitle: Roll out assistant versions gradually with canary releases and tests
description: Split live call traffic between published assistant versions by percentage, so you can canary a new version, run tests, and roll back instantly.
subtitle: Roll out assistant versions gradually with canary releases and experiments
description: Split live call traffic between published assistant versions by percentage, so you can canary a new version, run experiments, and roll back instantly.
slug: assistants/versioning/traffic-splitting
---

Expand All @@ -12,7 +12,7 @@ Traffic splitting routes a percentage of an assistant's live calls to each publi
Publishing an assistant changes what every caller hears. A prompt rewrite that reads well can still greet customers the wrong way, mishandle a transfer, or cause regressions in edge cases that review missed. Traffic splitting turns that all-or-nothing moment into a controlled rollout:

- **Canary releases**: Send a small share, such as 10%, of calls to the new version. If its calls look healthy, gradually raise the share to 100%. If they do not, remove it so the previous version immediately takes back the traffic.
- **Tests**: Run two versions side by side at 50/50 and compare their transcripts, call outcomes, and analysis before committing to either.
- **Experiments**: Run two versions side by side at 50/50 and compare their transcripts, call outcomes, and analysis before committing to either.
- **Staged parking**: Publish a version at 0% so it exists in history and is callable by version, without routing any live traffic to it until you are ready.

## How routing works
Expand Down Expand Up @@ -62,7 +62,7 @@ The **Traffic** entry in the assistant header shows whether calls are being spli

**An urgent fix during a rollout.** Remember that an explicit split pins traffic: publishing the fix does not route calls to it until you update the split. Publish at 100% if the fix should take everything, or add the fix's version to the split at the share you want.

**Comparing versions fairly.** Give the candidates equal shares and let repeat-caller affinity keep each customer's experience consistent while the test runs. The [Traffic tab](/assistants/versioning/traffic-tab) compares them side by side on duration, cost per minute, latency, and how calls ended. To read individual calls, filter the assistant's **Logs** tab by version; each call also records its version in the `assistantVersion` field, which is a column in call exports.
**Comparing versions fairly.** Give the candidates equal shares and let repeat-caller affinity keep each customer's experience consistent while the experiment runs. The [Traffic tab](/assistants/versioning/traffic-tab) compares them side by side on duration, cost per minute, latency, and how calls ended. To read individual calls, filter the assistant's **Logs** tab by version; each call also records its version in the `assistantVersion` field, which is a column in call exports.

## Splitting via the API

Expand Down
2 changes: 1 addition & 1 deletion fern/assistants/versioning/traffic-tab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Compare assistant versions on the Traffic tab or metrics API by cal
slug: assistants/versioning/traffic-tab
---

The **Traffic** tab shows each version of an assistant side by side on the calls it actually handled, so you can tell whether a new version is better. Use it to decide whether to raise a canary's share, keep a test running, or roll back, without exporting call logs or building your own report.
The **Traffic** tab shows each version of an assistant side by side on the calls it actually handled, so you can tell whether a new version is better. Use it to decide whether to raise a canary's share, keep an experiment running, or roll back, without exporting call logs or building your own report.

Every number on the tab comes from real calls in the window you choose. It does not change how calls are routed; to change the split itself, use the traffic editor described in [Traffic splitting](/assistants/versioning/traffic-splitting#editing-a-live-split).

Expand Down
2 changes: 1 addition & 1 deletion fern/billing/manage-billing-and-credits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: billing/manage-billing-and-credits
---

<Note>
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Settings → Billing & Add-Ons** instead, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing).
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Billing & Add-Ons** under **Settings** instead, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing).
</Note>

Vapi credits are prepaid funds in US dollars held by a subscription and used to cover its usage-based charges. This guide shows you how to add a payment method, fund the subscription, keep its balance funded automatically, and download billing records.
Expand Down
2 changes: 1 addition & 1 deletion fern/billing/manage-organizations-and-capacity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: billing/manage-organizations-and-capacity
Under the current pricing model, a subscription groups usage-based billing, an optional Success Package, add-ons, and one or more organizations. Usage only and each Success Package determine how many organizations the subscription can contain.

<Note>
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Settings → Billing & Add-Ons** instead, each organization has its own subscription and concurrency limit.
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Billing & Add-Ons** under **Settings** instead, each organization has its own subscription and concurrency limit.
</Note>

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion fern/billing/manage-packages-and-add-ons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: billing/manage-packages-and-add-ons
---

<Note>
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Settings → Billing & Add-Ons** instead, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing) or [Purchase call concurrency](/billing/purchase-call-concurrency).
This page applies if your Dashboard sidebar shows **Billing & Payment**. If you see **Billing & Add-Ons** under **Settings** instead, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing) or [Purchase call concurrency](/billing/purchase-call-concurrency).
</Note>

A Success Package applies to a subscription and every organization it contains. Usage-based billing remains active when you add, change, or remove a Success Package. You can also purchase add-ons that increase specific capabilities without changing your Success Package.
Expand Down
2 changes: 1 addition & 1 deletion fern/billing/manage-pay-as-you-go-billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: billing/manage-pay-as-you-go-billing
---

<Note>
This page applies if your Dashboard shows **Settings → Billing & Add-Ons**. In this view, each organization has its own subscription. If your Dashboard sidebar shows **Billing & Payment** instead, see [Manage billing and credits](/billing/manage-billing-and-credits).
This page applies if your Dashboard shows **Billing & Add-Ons** under **Settings**. In this view, each organization has its own subscription. If your Dashboard sidebar shows **Billing & Payment** instead, see [Manage billing and credits](/billing/manage-billing-and-credits).
</Note>

This guide shows you how to set up billing for a pay-as-you-go subscription. By the end, you can fund the subscription and configure automatic credit purchases.
Expand Down
2 changes: 1 addition & 1 deletion fern/billing/purchase-call-concurrency.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: billing/purchase-call-concurrency
---

<Note>
This page applies if your Dashboard shows **Settings → Billing & Add-Ons**. In this view, each organization has its own subscription and concurrency limit. If your Dashboard sidebar shows **Billing & Payment** instead, see [Manage Success Packages and add-ons](/billing/manage-packages-and-add-ons).
This page applies if your Dashboard shows **Billing & Add-Ons** under **Settings**. In this view, each organization has its own subscription and concurrency limit. If your Dashboard sidebar shows **Billing & Payment** instead, see [Manage Success Packages and add-ons](/billing/manage-packages-and-add-ons).
</Note>

Purchase call concurrency when your organization needs to run more simultaneous calls than its subscription includes.
Expand Down
2 changes: 1 addition & 1 deletion fern/debugging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Start with these immediate checks before diving deeper:
Test your voice agent directly in the [dashboard](https://dashboard.vapi.ai/):

<Card title="Assistants" icon="robot">
Click "Talk to Assistant" to test
Open your assistant and select **Talk** to test
</Card>

**Benefits:**
Expand Down
2 changes: 1 addition & 1 deletion fern/observability/boards-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ A Sales Performance Dashboard that displays:
Navigate to the Boards feature in your dashboard.

1. Log into your Vapi Dashboard at [dashboard.vapi.ai](https://dashboard.vapi.ai)
2. Click **Boards** in the left sidebar (under the "Reporting" or "Analytics" section)
2. Click **Boards** in the left sidebar (under **Observe**)
3. Your board will be automatically created on first visit

<Note>
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 @@ -74,7 +74,7 @@ Start with a booking assistant whose policy requires a timezone before booking.
<Steps>
<Step title="Navigate to Evals">
1. Log in to [dashboard.vapi.ai](https://dashboard.vapi.ai)
2. Click on **Evals** in the left sidebar (under Observability)
2. Click on **Evals** in the left sidebar (under Test)
3. Click **Create Evaluation**
</Step>

Expand Down
12 changes: 6 additions & 6 deletions fern/observability/monitoring-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Notifiers are alert channels (email, Slack, or webhook) that send notifications
<Steps>
<Step title="Navigate to notifiers">
1. Log in to [dashboard.vapi.ai](https://dashboard.vapi.ai)
2. Click on **Notifiers** in the left sidebar
2. In the left sidebar, under **Observe**, select **Monitoring**, then **Notifiers**
3. Click **New Notifier**
</Step>

Expand All @@ -120,7 +120,7 @@ Notifiers are alert channels (email, Slack, or webhook) that send notifications
</Tab>

<Tab title="cURL">
Notifiers are managed as credentials in the Dashboard. Navigate to **Notifiers** in the sidebar to create and manage your alert channels.
Notifiers are managed as credentials in the Dashboard. In the sidebar, select **Monitoring**, then **Notifiers** to create and manage your alert channels.

Once created, each notifier has a credential ID that you reference in your monitor trigger's `alert.credentialIds` array.
</Tab>
Expand Down Expand Up @@ -202,7 +202,7 @@ Define a monitor that tracks error rates and alerts you when errors exceed a thr
<Steps>
<Step title="Navigate to monitors">
1. Log in to [dashboard.vapi.ai](https://dashboard.vapi.ai)
2. Click on **Monitors** in the left sidebar (under Observability)
2. In the left sidebar, under **Observe**, select **Monitoring**, then **Monitors**
3. Click **New Monitor**
</Step>

Expand Down Expand Up @@ -314,7 +314,7 @@ Save the returned `id` for referencing this monitor later.

### Managing monitors

View, edit, and delete all your monitors from the **Monitors** page in the Dashboard sidebar (under Observe).
View, edit, and delete all your monitors from **Monitors** under **Monitoring** in the Dashboard sidebar (under Observe).

Via the API:
- `GET /monitoring/monitor` — list all monitors
Expand Down Expand Up @@ -373,7 +373,7 @@ When a threshold is exceeded and a trigger fires, an issue is created. You can v
<Tab title="Dashboard">
<Steps>
<Step title="Navigate to issues">
1. Click on **Issues** in the left sidebar
1. In the left sidebar, under **Observe**, select **Monitoring**, then **Issues**
2. View summary cards at the top showing total issues, open issues, and recently resolved issues
</Step>

Expand Down Expand Up @@ -478,7 +478,7 @@ Use AI-powered root cause analysis to understand why an issue occurred and get a
<Tab title="Dashboard">
<Steps>
<Step title="Open the issue">
1. Navigate to **Issues** in the sidebar
1. In the sidebar, select **Monitoring**, then **Issues**
2. Click on the issue you want to analyze
</Step>

Expand Down
2 changes: 1 addition & 1 deletion fern/providers/cloud/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Container names must follow [Azure naming rules](https://learn.microsoft.com/en-
Use [Azure's storage account access key instructions](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage) to find your connection string.
</Step>
<Step title="Open cloud provider credentials">
In the Vapi dashboard, open **Provider Credentials** > **Cloud Providers**.
In the Vapi dashboard, open **Integrations**, then select **Azure Blob Storage** under **Cloud Providers**.
</Step>
<Step title="Enter the storage settings">
Enter the connection string and container settings listed below.
Expand Down
6 changes: 3 additions & 3 deletions fern/providers/cloud/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: Store Vapi call recordings in Cloudflare R2 by configuring your R2

Your assistants can be configured to record chat conversations and upload
the recordings to a bucket in Cloudflare R2 when the conversation ends. You will
need to configure the credential and bucket settings in the "Cloud Providers"
section of the "Provider Credentials" page in the Vapi dashboard.
need to configure the credential and bucket settings in the **Cloud Providers**
section of the **Integrations** page in the Vapi dashboard.

See these [instructions](https://developers.cloudflare.com/r2/api/s3/tokens/) for generating R2 tokens and access keys.

Expand All @@ -28,5 +28,5 @@ Bucket Secret Access Key | The secret access key associated with the API token y
## Example

<Frame caption="Example Configuration">
<img src="../../static/images/credentials/provider/cloud-provider-cloudflare-r2.png" alt="Cloudflare credentials form in the Dashboard with Cloudflare Account ID, Account Email, and API Key or Token, plus optional bucket Name, URL, Path Prefix, Access Key ID, and Secret Access Key" />
<img src="../../static/images/credentials/provider/cloud-provider-cloudflare-r2.png" alt="Cloudflare R2 dialog in Dashboard Integrations with Cloudflare Account ID, Account Email, API Key or Token, and Fallback Index, plus optional bucket Name, URL, Path Prefix, Access Key ID, and Secret Access Key" />
</Frame>
6 changes: 3 additions & 3 deletions fern/providers/cloud/gcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: Store Vapi call recordings in Google Cloud Storage by configuring y

Your assistants can be configured to record chat conversations and upload
the recordings to a bucket in GCP Cloud Storage when the conversation ends. You will
need to configure the credential and bucket settings in the "Cloud Providers"
section of the "Provider Credentials" page in the Vapi dashboard.
need to configure the credential and bucket settings in the **Cloud Providers**
section of the **Integrations** page in the Vapi dashboard.

See these [instructions](https://cloud.google.com/iam/docs/keys-create-delete) for generating service account keys for GCP.

Expand All @@ -29,5 +29,5 @@ HMAC Secret | The HMAC secret for the GCP Clodu Storage API (
## Example

<Frame caption="Example Configuration">
<img src="../../static/images/credentials/provider/cloud-provider-gcp-hmac.png" alt="GCP credentials form in the Dashboard with Credential reference name, GCP Service Account Key JSON, and optional bucket Name, Bucket Region, Path Prefix, HMAC Access Key, and HMAC Secret" />
<img src="../../static/images/credentials/provider/cloud-provider-gcp-hmac.png" alt="Google Cloud Storage dialog in Dashboard Integrations with Credential reference name, GCP Service Account Key JSON, optional bucket Name, Bucket Region, Path Prefix, HMAC Access Key, and HMAC Secret, and Fallback Index" />
</Frame>
6 changes: 3 additions & 3 deletions fern/providers/cloud/s3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: Store Vapi call recordings in AWS S3 by configuring your S3 credent

Your assistants can be configured to record chat conversations and upload
the recordings to a bucket in AWS S3 when the conversation ends. You will
need to configure the credential and bucket settings in the "Cloud Providers"
section of the "Provider Credentials" page in the Vapi dashboard.
need to configure the credential and bucket settings in the **Cloud Providers**
section of the **Integrations** page in the Vapi dashboard.

See these [instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-keys-admin-managed.html) for generating AWS access keys.

Expand All @@ -24,5 +24,5 @@ Bucket Path Prefix | An optional path prefix for recordings uploaded to th
## Example

<Frame caption="Example Configuration">
<img src="../../static/images/credentials/provider/cloud-provider-aws-s3.png" alt="AWS S3 credentials form in the Dashboard with AWS Access Key ID, AWS Secret Access Key, S3 Bucket Region, S3 Bucket Name, and optional S3 Path Prefix" />
<img src="../../static/images/credentials/provider/cloud-provider-aws-s3.png" alt="AWS S3 dialog in Dashboard Integrations with AWS Access Key ID, AWS Secret Access Key, S3 Bucket Region, S3 Bucket Name, optional S3 Path Prefix, and Fallback Index" />
</Frame>
6 changes: 3 additions & 3 deletions fern/providers/cloud/supabase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: Store Vapi call recordings in Supabase Storage by configuring your

Your assistants can be configured to record chat conversations and upload
the recordings to a bucket in Supabase Storage when the conversation ends. You will
need to configure the credential and bucket settings in the "Cloud Providers"
section of the "Provider Credentials" page in the Vapi dashboard.
need to configure the credential and bucket settings in the **Cloud Providers**
section of the **Integrations** page in the Vapi dashboard.

See these [instructions](https://supabase.com/docs/guides/storage/s3/authentication) for generating Supabase tokens and access keys, and finding your endpoint and region.

Expand All @@ -26,5 +26,5 @@ Storage Secret Access Key | The secret access key for Supabase Storage, associat
## Example

<Frame caption="Example Configuration">
<img src="../../static/images/credentials/provider/cloud-provider-supabase-s3.png" alt="Supabase credentials form in the Dashboard with Bucket Name, Bucket Region, Path Prefix, Supabase S3 Connection Endpoint, S3 Access Key ID, and S3 Secret Access Key" />
<img src="../../static/images/credentials/provider/cloud-provider-supabase-s3.png" alt="Supabase dialog in Dashboard Integrations with Bucket Name, Bucket Region, Path Prefix, Supabase S3 Connection Endpoint, S3 Access Key ID, S3 Secret Access Key, and Fallback Index" />
</Frame>
Loading
Loading