Commit 142b2ce
authored
docs: clarify pronunciation dictionaries support Vapi v1 voices only (#1071)
## Description
Problem: The pronunciation dictionaries page never said which Vapi voices support the feature, and its example used `version: 2` (a Grok voice) with a pronunciation dictionary — a config the backend actually rejects.
This clarifies that pronunciation dictionaries work on **Vapi v1 voices only**, points v2 (Grok) users to speech tags instead, and fixes the misleading example.
- Added a note that pronunciation dictionaries are supported on Vapi **v1** voices only. Vapi **v2** voices are powered by xAI's Grok model and don't support them yet — with a link to [xAI speech tags](https://docs.x.ai/developers/model-capabilities/audio/text-to-speech#speech-tags) as the alternative.
- Fixed the Vapi built-in voice example: `version: 2` + `Elliot` → `version: 1` + `Kylie` (a v1 voice that maps to Cartesia `sonic-3`, so it genuinely supports a dictionary).
- Small callout: the Cartesia dictionary option only appears in the dashboard once a `sonic-3` (or newer) model is selected.
File: `fern/assistants/pronunciation-dictionaries.mdx`. No navigation changes.
Related: [PRISM-475](https://linear.app/vapi/issue/PRISM-475/platform-cartesia-pronunciation-dictionary-dashboard-ui-surface) (pronunciation dictionary dashboard work). Companion to the dashboard link fix in VapiAI/vapi#13221.
## Testing Steps
- [x] `fern check` — 0 errors (5 pre-existing config warnings, none on this page)
- [x] JSON example valid (the edited Vapi voice config parses)
- [x] No new internal links (only added link is the external xAI speech-tags URL)
- [x] Example cross-checked against source — voice version mappings in `libs/core/.../voice.types/vapi.types.ts` (Kylie → v1 Cartesia `sonic-3`; v2 = xAI/Grok, no dictionary support)
- [x] Style: active voice, present tense, no marketing language
- [ ] Confirm the v1/v2 note and Cartesia callout render in the preview deployment1 parent 636ec01 commit 142b2ce
1 file changed
Lines changed: 8 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
16 | 20 | | |
17 | 21 | | |
18 | 22 | | |
| |||
88 | 92 | | |
89 | 93 | | |
90 | 94 | | |
91 | | - | |
| 95 | + | |
92 | 96 | | |
93 | 97 | | |
94 | 98 | | |
| |||
242 | 246 | | |
243 | 247 | | |
244 | 248 | | |
245 | | - | |
246 | | - | |
| 249 | + | |
| 250 | + | |
247 | 251 | | |
248 | 252 | | |
249 | 253 | | |
| |||
0 commit comments