Skip to content

docs: add Cartesia support to pronunciation dictionaries#1041

Open
dhruva-reddy wants to merge 1 commit intomainfrom
dr/docs-cartesia-pronunciation-dictionaries
Open

docs: add Cartesia support to pronunciation dictionaries#1041
dhruva-reddy wants to merge 1 commit intomainfrom
dr/docs-cartesia-pronunciation-dictionaries

Conversation

@dhruva-reddy
Copy link
Copy Markdown
Contributor

@dhruva-reddy dhruva-reddy commented May 7, 2026

Description

  • Updates fern/assistants/pronunciation-dictionaries.mdx to cover Cartesia in addition to ElevenLabs
  • Adds a "Provider support" matrix at the top documenting model requirements + field shape per provider
  • Wraps the Implementation section in <Tabs> with parallel Cartesia / ElevenLabs flows
  • Adds a "Bring Your Own Key (BYOK)" section covering the Found credentials for {provider}. Use {provider}'s API with your own credentials... rejection that fires for both Cartesia and ElevenLabs BYOK orgs
  • Adds explicit warning callouts about the upstream resourceId vs Vapi UUID footgun — the most common customer mistake when wiring a newly-created dictionary onto a voice
  • Generalizes the "Managing Pronunciation Dictionaries" section to use {provider} placeholder for List / Update / Delete endpoints
  • Updates Best Practices and Common Issues to reflect both providers

Resolves PRISM-474 deliverable #5.

This PR is unblocked now that PR #11683 (VapiAI/vapi: feat(voice): require sonic-3 model when Cartesia pronunciationDictId is set) has merged. The previous version of this page claimed pronunciation dictionaries were "exclusive to ElevenLabs" — that's no longer accurate.

Related Vapi PRs (for context)

  • #11683 — Backend: validator gate that requires sonic-3 for Cartesia pronunciationDictId (MERGED)
  • #11691 — Backend: stale-ref detection (voiceWarnings field on assistant findOne) (OPEN)
  • #11698 — Dashboard: read-only viewer for currently-attached dicts (OPEN)
  • #11709 — Dashboard: voice form refactor preparing for the picker UI (OPEN)
  • #11715 — Dashboard: <PronunciationDictionarySelect> picker UI for both providers (OPEN)

When PRs #11691 / #11698 / #11715 land, a follow-up docs PR can add: stale-ref detection / voiceWarnings, dashboard UI screenshots, and the dashboard-driven flow.

Testing Steps

  • Run fern check — passes with 0 errors (5 pre-existing warnings)
  • Verify JSON examples are valid — 9/9 JSON blocks parse cleanly
  • Internal links unchanged from previous version (no new cross-references added)
  • Confirm new content renders correctly in the preview deployment (especially the <Tabs> for Cartesia/ElevenLabs split and the <Warning> callouts)
  • Confirm the navigation entry for assistants/pronunciation-dictionaries is unchanged (no docs.yml update needed)
  • Cross-check API field documentation against the source PRs (especially the Cartesia create/response envelope shape)
  • Style guide compliance: active voice, present tense, no marketing language, second person ("you")
  • Code examples use YOUR_API_KEY placeholder, no real keys committed

Process notes

This PR skips the test-writer / code-reviewer phases per the project rule for docs-only PRs.

PR #11683 (Cartesia sonic-3 validation gate) merged, so customers can now
attach pronunciation dictionaries to Cartesia voices via voice.pronunciationDictId.
This page previously claimed pronunciation dictionaries were "exclusive to
ElevenLabs" — update to cover both providers with parallel implementation
examples, BYOK behavior, and the upstream-resourceId vs Vapi-UUID gotcha.
Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant