From 1d365fa6dd2ee809f0fae4a21b8a773a1e7b3432 Mon Sep 17 00:00:00 2001 From: Steve Date: Mon, 22 Jun 2026 12:42:32 -0700 Subject: [PATCH 1/3] WIP: Cartesia custom voices docs --- fern/customization/custom-voices/cartesia.mdx | 92 +++++++++++++++ fern/docs.yml | 3 + fern/fern.config.json | 2 +- fern/providers/voice/overview.mdx | 109 ++++++++++++++++++ 4 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 fern/customization/custom-voices/cartesia.mdx create mode 100644 fern/providers/voice/overview.mdx diff --git a/fern/customization/custom-voices/cartesia.mdx b/fern/customization/custom-voices/cartesia.mdx new file mode 100644 index 000000000..e152aae2c --- /dev/null +++ b/fern/customization/custom-voices/cartesia.mdx @@ -0,0 +1,92 @@ +--- +title: Cartesia +subtitle: Use your own custom Cartesia voice in Vapi +description: Use a custom Cartesia voice in Vapi by connecting your Cartesia API key and referencing the voice ID. +slug: customization/custom-voices/cartesia +--- + + + **Just want to use a Cartesia voice?** Cartesia's prebuilt voices are already + available in Vapi, no setup required. Browse them in the + [Voice Library](https://dashboard.vapi.ai/library/voice) (filter by Cartesia) + or in your assistant's **Voice** dropdown, then select one. See + [Finding voices](/providers/voice/overview). + + Follow this page only if you want to use your **own custom (cloned)** Cartesia voice. + + +Cartesia is a built-in provider, so you don't import or sync a cloned voice into +Vapi the way you do with ElevenLabs or PlayHT. Instead, you create the voice in +Cartesia, connect your Cartesia API key, and reference the voice by its ID. + +## Before you start + +- A Cartesia account and [API key](https://docs.cartesia.ai/get-started/authenticate-your-client-applications). +- A custom voice created in Cartesia, using + [Instant Voice Clone](https://docs.cartesia.ai/build-with-cartesia/capability-guides/clone-voices) + or [Pro Voice Clone](https://docs.cartesia.ai/build-with-cartesia/capability-guides/clone-voices-pro/playground). + +## Set up + + + + + + + Go to [Settings → Integrations → Cartesia](https://dashboard.vapi.ai/settings/integrations) + and enter your Cartesia **API Key**, then click **Save**. (The optional + **API URL** is only needed for an on-prem Cartesia instance.) + + + Open an assistant and click the edit (pencil) icon on the **Voice** card to + open **Voice Settings**, then choose **Cartesia** as the provider. Your + private voices become available. Select yours from the list, or switch to + **Custom Voice ID** and paste your Cartesia voice ID. + + + + + + + + + Create a credential with your Cartesia API key. Vapi attaches it to your + organization automatically, so you don't reference it on the voice. + + + ```bash title="cURL" + curl -X POST "https://api.vapi.ai/credential" \ + -H "Authorization: Bearer $VAPI_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "provider": "cartesia", + "apiKey": "YOUR_CARTESIA_API_KEY" + }' + ``` + + + + Set the assistant's `voice` to your Cartesia voice ID. You can find your + voice IDs with the [List Voices API](https://docs.cartesia.ai/api-reference/voices/list). + + + ```json title="Assistant voice configuration" + { + "voice": { + "provider": "cartesia", + "voiceId": "YOUR_CARTESIA_VOICE_ID", + "model": "sonic-3.5" + } + } + ``` + + + + + + + + + A custom voice only resolves once your Cartesia credential is saved. If Vapi + can't find the voice, double-check that your Cartesia API key is connected. + diff --git a/fern/docs.yml b/fern/docs.yml index e61f7ca67..65c893bb8 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -246,6 +246,8 @@ navigation: path: customization/custom-voices/elevenlabs.mdx - page: PlayHT path: customization/custom-voices/playht.mdx + - page: Cartesia + path: customization/custom-voices/cartesia.mdx - page: Custom transcriber path: customization/custom-transcriber.mdx icon: fa-light fa-microphone @@ -599,6 +601,7 @@ navigation: icon: fa-light fa-link contents: - section: Voices (Text-to-speech) + path: providers/voice/overview.mdx icon: fa-light fa-waveform-lines contents: - section: Vapi Voices diff --git a/fern/fern.config.json b/fern/fern.config.json index 9ff1dce1d..96e92ea20 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "vapi", - "version": "4.63.5" + "version": "5.50.2" } diff --git a/fern/providers/voice/overview.mdx b/fern/providers/voice/overview.mdx new file mode 100644 index 000000000..a01a579de --- /dev/null +++ b/fern/providers/voice/overview.mdx @@ -0,0 +1,109 @@ +--- +title: Voices (Text-to-speech) +subtitle: Find, preview, and use voices from any supported provider +description: Find, preview, and use text-to-speech voices from any Vapi-supported provider. Look up a voiceId in the dashboard or with the Voice Library API. +slug: providers/voice/overview +--- + +Vapi supports text-to-speech (TTS) voices from many providers. You choose a voice +by setting the `provider` and `voiceId` on your assistant's `voice` configuration — +see [Create Assistant](/api-reference/assistants/create) in the API reference. + +```bash title="Set an assistant's voice" +curl -X PATCH "https://api.vapi.ai/assistant/ASSISTANT_ID" \ + -H "Authorization: Bearer $VAPI_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "voice": { + "provider": "cartesia", + "voiceId": "VOICE_ID" + } + }' +``` + +This page shows you how to find a `voiceId` in the dashboard or via the API, and +links to every supported provider. + +## Find a voice in the dashboard + +The [Voice Library](https://dashboard.vapi.ai/library/voice) is the complete list +of every voice available to your organization. Browse and preview voices there, +then copy a voice's ID to use on an assistant. You can also bring your own custom +voices — see [Custom voices](/customization/custom-voices/custom-voice) for more +information. + + + + Open the [Voice Library](https://dashboard.vapi.ai/library/voice), filter by + **Provider**, and search by name. Press play on a voice to preview it. + + + Click the copy icon on a voice to copy its ID. + + + Open an assistant and click the edit (pencil) icon on the **Voice** card to + open **Voice Settings**. Choose the **Provider** and **Voice**, or paste the + copied ID under **Custom Voice ID**. + + + + + The **Voice** dropdown in the assistant editor shows only a subset of voices — + not the full catalog. To use a voice that isn't listed there, find it in the + [Voice Library](https://dashboard.vapi.ai/library/voice), copy its ID, and paste + it under **Custom Voice ID**. You can also bring your own custom voices — see + [Custom voices](/customization/custom-voices/custom-voice) for more information. + + + + Some providers also let you bring your own voices. See the provider's page below + (for example, [ElevenLabs](/customization/custom-voices/elevenlabs), + [PlayHT](/customization/custom-voices/playht), or + [Cartesia](/customization/custom-voices/cartesia)) for custom-voice setup. + + +## Find a voice with the API + +To list the voices available for a provider, call the Voice Library endpoint: + + +```bash title="cURL" +curl "https://api.vapi.ai/voice-library/cartesia" \ + -H "Authorization: Bearer $VAPI_API_KEY" +``` + + +Each entry includes a `providerId`, which is the value you set as `voiceId` on +your assistant: + +```json +{ + "providerId": "f91ab3e6-5071-4e15-b016-cde6f2bcd222", + "provider": "cartesia", + "name": "Aadhya - Soother", + "description": "Slow female voice for casual conversation", + "isPublic": true +} +``` + + + Results are paginated, and `isPublic` distinguishes prebuilt voices (`true`) + from custom voices synced to your organization (`false`). Replace `cartesia` + in the path with any supported provider. + + +## Supported voice providers + + + + + + + + + + + + + + From c56484f5629130447771f589442b2c9128b0a436 Mon Sep 17 00:00:00 2001 From: Steve Date: Wed, 24 Jun 2026 14:28:12 -0700 Subject: [PATCH 2/3] Updated draft --- fern/customization/custom-voices/cartesia.mdx | 91 +++---------------- fern/fern.config.json | 2 +- fern/providers/voice/overview.mdx | 68 +++----------- 3 files changed, 27 insertions(+), 134 deletions(-) diff --git a/fern/customization/custom-voices/cartesia.mdx b/fern/customization/custom-voices/cartesia.mdx index e152aae2c..cb52dfec8 100644 --- a/fern/customization/custom-voices/cartesia.mdx +++ b/fern/customization/custom-voices/cartesia.mdx @@ -1,92 +1,27 @@ --- title: Cartesia -subtitle: Use your own custom Cartesia voice in Vapi -description: Use a custom Cartesia voice in Vapi by connecting your Cartesia API key and referencing the voice ID. +subtitle: Set up a custom Cartesia voice in Vapi +description: Use a custom Cartesia voice in Vapi by connecting your Cartesia API key and selecting your voice. slug: customization/custom-voices/cartesia --- - - **Just want to use a Cartesia voice?** Cartesia's prebuilt voices are already - available in Vapi, no setup required. Browse them in the - [Voice Library](https://dashboard.vapi.ai/library/voice) (filter by Cartesia) - or in your assistant's **Voice** dropdown, then select one. See - [Finding voices](/providers/voice/overview). +This guide shows you how to use a voice you created with Cartesia in your Vapi assistant. Cartesia's prebuilt voices are already available in the [Voice Library](/providers/voice/overview); follow this page only to use your own custom voice. - Follow this page only if you want to use your **own custom (cloned)** Cartesia voice. - - -Cartesia is a built-in provider, so you don't import or sync a cloned voice into -Vapi the way you do with ElevenLabs or PlayHT. Instead, you create the voice in -Cartesia, connect your Cartesia API key, and reference the voice by its ID. - -## Before you start - -- A Cartesia account and [API key](https://docs.cartesia.ai/get-started/authenticate-your-client-applications). -- A custom voice created in Cartesia, using - [Instant Voice Clone](https://docs.cartesia.ai/build-with-cartesia/capability-guides/clone-voices) - or [Pro Voice Clone](https://docs.cartesia.ai/build-with-cartesia/capability-guides/clone-voices-pro/playground). - -## Set up - - - +A Cartesia account and API key are required for this process. - - Go to [Settings → Integrations → Cartesia](https://dashboard.vapi.ai/settings/integrations) - and enter your Cartesia **API Key**, then click **Save**. (The optional - **API URL** is only needed for an on-prem Cartesia instance.) + + Sign up at [Cartesia](https://play.cartesia.ai), then create a custom voice in the [Cartesia playground](https://play.cartesia.ai/voices). - - Open an assistant and click the edit (pencil) icon on the **Voice** card to - open **Voice Settings**, then choose **Cartesia** as the provider. Your - private voices become available. Select yours from the list, or switch to - **Custom Voice ID** and paste your Cartesia voice ID. + + Get your API key from your Cartesia account. - + + In the [Vapi Dashboard](https://dashboard.vapi.ai), open **Settings**, then **Integrations**, and add your Cartesia API key under **Cartesia**. - - - - - - Create a credential with your Cartesia API key. Vapi attaches it to your - organization automatically, so you don't reference it on the voice. - - - ```bash title="cURL" - curl -X POST "https://api.vapi.ai/credential" \ - -H "Authorization: Bearer $VAPI_API_KEY" \ - -H "Content-Type: application/json" \ - -d '{ - "provider": "cartesia", - "apiKey": "YOUR_CARTESIA_API_KEY" - }' - ``` - + Once you save, your Cartesia voices sync automatically. - - Set the assistant's `voice` to your Cartesia voice ID. You can find your - voice IDs with the [List Voices API](https://docs.cartesia.ai/api-reference/voices/list). - - - ```json title="Assistant voice configuration" - { - "voice": { - "provider": "cartesia", - "voiceId": "YOUR_CARTESIA_VOICE_ID", - "model": "sonic-3.5" - } - } - ``` - + + Open an assistant and open **Voice Settings**. Choose **Cartesia** as the provider and select your voice, or switch to **Custom Voice ID** and paste your Cartesia voice ID. - - - - - - A custom voice only resolves once your Cartesia credential is saved. If Vapi - can't find the voice, double-check that your Cartesia API key is connected. - diff --git a/fern/fern.config.json b/fern/fern.config.json index 96e92ea20..9ff1dce1d 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "vapi", - "version": "5.50.2" + "version": "4.63.5" } diff --git a/fern/providers/voice/overview.mdx b/fern/providers/voice/overview.mdx index a01a579de..effd0504f 100644 --- a/fern/providers/voice/overview.mdx +++ b/fern/providers/voice/overview.mdx @@ -1,13 +1,13 @@ --- title: Voices (Text-to-speech) subtitle: Find, preview, and use voices from any supported provider -description: Find, preview, and use text-to-speech voices from any Vapi-supported provider. Look up a voiceId in the dashboard or with the Voice Library API. +description: Find, preview, and use text-to-speech voices from any Vapi-supported provider, and look up a voiceId in the Vapi dashboard. slug: providers/voice/overview --- Vapi supports text-to-speech (TTS) voices from many providers. You choose a voice -by setting the `provider` and `voiceId` on your assistant's `voice` configuration — -see [Create Assistant](/api-reference/assistants/create) in the API reference. +by setting the `provider` and `voiceId` on your assistant's `voice` configuration. +See [Create Assistant](/api-reference/assistants/create) in the API reference. ```bash title="Set an assistant's voice" curl -X PATCH "https://api.vapi.ai/assistant/ASSISTANT_ID" \ @@ -15,27 +15,26 @@ curl -X PATCH "https://api.vapi.ai/assistant/ASSISTANT_ID" \ -H "Content-Type: application/json" \ -d '{ "voice": { - "provider": "cartesia", + "provider": "PROVIDER", "voiceId": "VOICE_ID" } }' ``` -This page shows you how to find a `voiceId` in the dashboard or via the API, and -links to every supported provider. +This page shows you how to find a `voiceId` in the dashboard, and links to every +supported provider. ## Find a voice in the dashboard -The [Voice Library](https://dashboard.vapi.ai/library/voice) is the complete list -of every voice available to your organization. Browse and preview voices there, -then copy a voice's ID to use on an assistant. You can also bring your own custom -voices — see [Custom voices](/customization/custom-voices/custom-voice) for more -information. +The **Voice Library** in the [Vapi Dashboard](https://dashboard.vapi.ai) lists every +voice available to your organization. Browse and preview voices there, then copy a +voice's ID to use on an assistant. - Open the [Voice Library](https://dashboard.vapi.ai/library/voice), filter by - **Provider**, and search by name. Press play on a voice to preview it. + In the [Vapi Dashboard](https://dashboard.vapi.ai), open **Resources**, then + **Voice Library**. Filter by **Provider** and search by name. Press play on a + voice to preview it. Click the copy icon on a voice to copy its ID. @@ -47,51 +46,10 @@ information. - - The **Voice** dropdown in the assistant editor shows only a subset of voices — - not the full catalog. To use a voice that isn't listed there, find it in the - [Voice Library](https://dashboard.vapi.ai/library/voice), copy its ID, and paste - it under **Custom Voice ID**. You can also bring your own custom voices — see - [Custom voices](/customization/custom-voices/custom-voice) for more information. - - - Some providers also let you bring your own voices. See the provider's page below - (for example, [ElevenLabs](/customization/custom-voices/elevenlabs), - [PlayHT](/customization/custom-voices/playht), or - [Cartesia](/customization/custom-voices/cartesia)) for custom-voice setup. + Some providers also let you use your own custom voice. See [Custom voices](/customization/custom-voices/custom-voice) for setup. -## Find a voice with the API - -To list the voices available for a provider, call the Voice Library endpoint: - - -```bash title="cURL" -curl "https://api.vapi.ai/voice-library/cartesia" \ - -H "Authorization: Bearer $VAPI_API_KEY" -``` - - -Each entry includes a `providerId`, which is the value you set as `voiceId` on -your assistant: - -```json -{ - "providerId": "f91ab3e6-5071-4e15-b016-cde6f2bcd222", - "provider": "cartesia", - "name": "Aadhya - Soother", - "description": "Slow female voice for casual conversation", - "isPublic": true -} -``` - - - Results are paginated, and `isPublic` distinguishes prebuilt voices (`true`) - from custom voices synced to your organization (`false`). Replace `cartesia` - in the path with any supported provider. - - ## Supported voice providers From 6dbc4b2ad444ab26ba3e07245248ffe6302b81b4 Mon Sep 17 00:00:00 2001 From: Steve Date: Wed, 24 Jun 2026 15:13:39 -0700 Subject: [PATCH 3/3] Added a link to find voices --- fern/customization/custom-voices/cartesia.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/customization/custom-voices/cartesia.mdx b/fern/customization/custom-voices/cartesia.mdx index cb52dfec8..369df8498 100644 --- a/fern/customization/custom-voices/cartesia.mdx +++ b/fern/customization/custom-voices/cartesia.mdx @@ -22,6 +22,6 @@ This guide shows you how to use a voice you created with Cartesia in your Vapi a Once you save, your Cartesia voices sync automatically. - Open an assistant and open **Voice Settings**. Choose **Cartesia** as the provider and select your voice, or switch to **Custom Voice ID** and paste your Cartesia voice ID. + Open an assistant and open **Voice Settings**. Choose **Cartesia** as the provider and select your voice, or switch to **Custom Voice ID** and paste your Cartesia voice ID. You can find your voice ID in the [Voice Library](/providers/voice/overview).