Skip to content

Commit b6025e3

Browse files
add docs for fallback plan
1 parent ef0d527 commit b6025e3

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

fern/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,8 @@ navigation:
244244
path: tools-calling.mdx
245245
- page: Prompting Guide
246246
path: prompting-guide.mdx
247+
- page: Voice Fallback Plan
248+
path: voice-fallback-plan.mdx
247249
- page: OpenAI Realtime
248250
path: openai-realtime.mdx
249251
- section: Glossary

fern/voice-fallback-plan.mdx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Voice Fallback Plan
3+
subtitle: You can configure your assistants to fallback to other voices when your primary voice fails.
4+
slug: voice-fallback-plan
5+
---
6+
7+
<Note>
8+
Voice fallback plans can currently only be configured through the API. We are working on making this available through our dashboard.
9+
</Note>
10+
11+
## Introduction
12+
13+
Prior to the addition of fallback plans, calls would terminate if an assistant's voice experienced any failure, regardless of whether the issue originated from the voice provider or Vapi.
14+
15+
Fallback plans allow your assistant to continue the call in the scenario that your primary voice fails. Your assistant will sequentially fallback to the voices you configure within your plan, until there are no voices left.
16+
17+
## How It Works
18+
19+
When a voice failure occurs, Vapi will:
20+
1. Detect the failure of the primary voice
21+
2. Automatically switch to the first fallback voice
22+
3. Continue through the list of fallback voices if subsequent failures occur
23+
4. Only terminate if all configured fallback voices fail
24+
25+
## Configuration
26+
27+
Add the `fallbackPlan` property to your assistant's voice configuration. Specify a list of voices within the `voices` property of `fallbackPlan`, and you're done!
28+
- Please note that fallback voices must be valid JSON configurations, and not strings.
29+
30+
```json
31+
{
32+
"voice": {
33+
"provider": "openai",
34+
"voiceId": "shimmer",
35+
"fallbackPlan": {
36+
"voices": [
37+
{
38+
"provider": "cartesia",
39+
"voiceId": "248be419-c632-4f23-adf1-5324ed7dbf1d",
40+
},
41+
{
42+
"provider": "playht",
43+
"voiceId": "jennifer"
44+
}
45+
]
46+
}
47+
}
48+
}
49+
```
50+
51+
## Best practices
52+
53+
- Use <b>different providers</b> for your fallback voices to protect against provider-wide outages.
54+
- Select voices with similar characteristics (tone, accent, gender) to maintain consistency in the user experience.
55+
56+
## How will pricing work?
57+
58+
There is no change to the pricing of the voices. Your call will not incur any extra fees while using fallback voices, and you will be able to see the cost for each voice in your end-of-call report.

0 commit comments

Comments
 (0)