docs: clarify pronunciation dictionaries support Vapi v1 voices only#1071
Merged
bets-margulies-vapi merged 1 commit intoJun 12, 2026
Merged
Conversation
- Note that Vapi v2 (xAI/Grok) voices don't support pronunciation dictionaries yet, and link to xAI speech tags as the alternative. - Fix the Vapi built-in voice example: v2 + Elliot was invalid (Grok has no dictionary support and Elliot's v1 route is sonic-2); use v1 + Kylie (a v1 voice that maps to Cartesia sonic-3). - Small callout: the Cartesia dictionary option only appears in the dashboard once a sonic-3 (or newer) model is selected. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Contributor
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
|
🌿 Preview your docs: https://vapi-preview-992f29b9-e1a3-4850-bc1b-f149dc90aa1f.docs.buildwithfern.com |
bets-margulies-vapi
approved these changes
Jun 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
version: 2+Elliot→version: 1+Kylie(a v1 voice that maps to Cartesiasonic-3, so it genuinely supports a dictionary).sonic-3(or newer) model is selected.File:
fern/assistants/pronunciation-dictionaries.mdx. No navigation changes.Related: PRISM-475 (pronunciation dictionary dashboard work). Companion to the dashboard link fix in VapiAI/vapi#13221.
Testing Steps
fern check— 0 errors (5 pre-existing config warnings, none on this page)libs/core/.../voice.types/vapi.types.ts(Kylie → v1 Cartesiasonic-3; v2 = xAI/Grok, no dictionary support)