> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supertoneapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Custom voices
> Voice clones you register and manage on your own account — create, list, search, update, and delete.
A **custom voice** is a voice clone tied to your account. Once registered, it behaves exactly like a preset voice — same TTS endpoint, same parameters — but it lives at a separate set of endpoints and is only callable by the account that created it.
Custom voices can be created two ways:
* **In [Supertone Play](https://play.supertone.ai)** — upload a sample and clone through the UI.
* **Via the API** — `POST /v1/custom-voices/cloned-voice` with an audio file.
Either path produces the same kind of voice. Voices cloned in Play show up in `list_custom_voices`, and voices cloned via the API show up in Play. There's no sync step.
Voice cloning **via the API** is not available on the Free tier. Cloning in Play is available on all paid tiers.
## Endpoint overview
| Endpoint | Purpose |
| ------------------------------------- | ------------------------------------------------- |
| `POST /v1/custom-voices/cloned-voice` | Create a new clone from an uploaded audio sample. |
| `GET /v1/custom-voices` | List all custom voices on your account. |
| `GET /v1/custom-voices/search` | Filter custom voices by name or description. |
| `GET /v1/custom-voices/{voice_id}` | Retrieve a single custom voice. |
| `PATCH /v1/custom-voices/{voice_id}` | Update name or description. |
| `DELETE /v1/custom-voices/{voice_id}` | Permanently delete a custom voice. |
## Create a clone
Upload a clean audio sample of the voice you want to clone:
```python theme={"dark"}
import os
from supertone import Supertone
with Supertone(api_key=os.environ["SUPERTONE_API_KEY"]) as client:
with open("voice_sample.wav", "rb") as f:
response = client.custom_voices.create_cloned_voice(
files={"file_name": "voice_sample.wav", "content": f.read()},
name="Hana — narrator voice",
description="Calm, mid-pitch female voice for audiobook narration.",
)
print("Created custom voice:", response.voice_id)
```
```typescript theme={"dark"}
import { Supertone } from "@supertone/supertone";
import * as fs from "node:fs";
const client = new Supertone({ apiKey: process.env.SUPERTONE_API_KEY });
const audio = fs.readFileSync("voice_sample.wav");
const response = await client.customVoices.createClonedVoice({
files: { fileName: "voice_sample.wav", content: audio },
name: "Hana — narrator voice",
description: "Calm, mid-pitch female voice for audiobook narration.",
});
console.log("Created custom voice:", response.voiceId);
```
```bash theme={"dark"}
curl -X POST "https://supertoneapi.com/v1/custom-voices/cloned-voice" \
-H "x-sup-api-key: $SUPERTONE_API_KEY" \
-F "files=@voice_sample.wav" \
-F "name=Hana — narrator voice" \
-F "description=Calm, mid-pitch female voice for audiobook narration."
```
The response includes the new `voice_id`. Save it — that's what you'll pass to TTS calls.
### Upload constraints
* **Format:** WAV or MP3
* **Size:** under 3 MB
* **Name:** up to 100 characters
Clean, mono, single-speaker audio (5–30 seconds) yields the best clones. Avoid background music, multiple voices, or heavy room noise.
## List and search
```python theme={"dark"}
# List all
result = client.custom_voices.list_custom_voices(page_size=20)
for voice in result.items or []:
print(voice.voice_id, voice.name)
# Search by name or description
result = client.custom_voices.search_custom_voices(name="narrator")
```
```typescript theme={"dark"}
// List all
const list = await client.customVoices.listCustomVoices({ pageSize: 20 });
for (const voice of list.items ?? []) {
console.log(voice.voiceId, voice.name);
}
// Search by name or description
const search = await client.customVoices.searchCustomVoices({ name: "narrator" });
```
```bash theme={"dark"}
# List all
curl "https://supertoneapi.com/v1/custom-voices?page_size=20" \
-H "x-sup-api-key: $SUPERTONE_API_KEY"
# Search
curl "https://supertoneapi.com/v1/custom-voices/search?name=narrator" \
-H "x-sup-api-key: $SUPERTONE_API_KEY"
```
## Use a custom voice in TTS
Once the clone is registered, call `text_to_speech.create_speech` exactly like you would with a preset voice — just pass the custom `voice_id`:
```python theme={"dark"}
response = client.text_to_speech.create_speech(
voice_id=CUSTOM_VOICE_ID,
text="The first chapter begins on a quiet rainy morning.",
language="en",
model="sona_speech_2",
)
```
Custom voices support the same `voice_settings`, `output_format`, `include_phonemes`, and `normalized_text` fields as preset voices.
## Update or delete
```python theme={"dark"}
# Rename / update description
client.custom_voices.edit_custom_voice(
voice_id=CUSTOM_VOICE_ID,
name="Hana — narrator (v2)",
description="Improved take with cleaner room tone.",
)
# Permanently delete
client.custom_voices.delete_custom_voice(voice_id=CUSTOM_VOICE_ID)
```
```typescript theme={"dark"}
// Rename / update description
await client.customVoices.editCustomVoice({
voiceId: CUSTOM_VOICE_ID,
name: "Hana — narrator (v2)",
description: "Improved take with cleaner room tone.",
});
// Permanently delete
await client.customVoices.deleteCustomVoice({ voiceId: CUSTOM_VOICE_ID });
```
## Important constraints
* **Account-scoped.** A custom voice is callable only by the account that created it. Calling someone else's custom voice — even if you know the ID — returns `403 Forbidden`.
* **Same credits.** Custom voice calls deduct credits at the same rate as preset voices.
* **Permissions and disclosure.** Make sure you have rights to clone any voice you upload. Check your jurisdiction's rules around AI-generated voices and end-user disclosure.
## Related
Browse and search Supertone's preset voice library.
Clone, list, and use a custom voice in TTS.
Full request and response schema.
Forecast cost and monitor per-voice usage.