DocsVoices
Voices
Voices API
Manage system catalog voices and organization custom voices. SYSTEM voices are globally readable; CUSTOM voices are organization scoped.
Categories and upload format
Voice creation uses multipart form data. Supported audio types: wav, mpeg, mp4, flac, ogg, webm.
audiobookconversationalcustomer_servicegeneralnarrativecharactersmeditationmotivationalpodcastadvertisingvoiceovercorporate
Org boundary enforcement
Custom voices are only accessible by the owning organization through API key auth. System voices remain globally readable via the public catalog endpoint.
GET
/api/v1/voicesAPI KeyList system and organization voices visible to the API key.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| query | string | No | Optional case-insensitive search over voice name and description. |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| data[] | Voice | No | Array of system and custom voices. |
| data[].variant | SYSTEM | CUSTOM | No | Indicates whether voice is global or org-owned. |
| data[].sample_prompt | string | null | No | Included for system catalog entries. |
bashcURL2 lines
curl -X GET 'https://app.clariva.ai/api/v1/voices?query=aaron' \
-H 'Authorization: Bearer $CLARIVA_API_KEY'jsonResponse12 lines
{
"data": [
{
"id": "voi_01jv3q2w0f4m5myn4q1q8r1g8a",
"name": "Aaron",
"category": "narrative",
"language": "en-US",
"variant": "SYSTEM",
"created_at": "2026-05-18T08:20:13.000Z"
}
]
}GET
/api/v1/voices/systemPublicList public system voices without authentication.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| data[] | Voice | No | Public system catalog only. |
bashcURL1 lines
curl -X GET 'https://app.clariva.ai/api/v1/voices/system'GET
/api/v1/voices/{voice_id}API KeyFetch one voice by id.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| data | Voice | No | Single voice object with category, language, and variant. |
bashcURL2 lines
curl -X GET 'https://app.clariva.ai/api/v1/voices/voi_123' \
-H 'Authorization: Bearer $CLARIVA_API_KEY'POST
/api/v1/voicesAPI KeyCreate a custom org-owned voice via multipart upload.
Audio supports wav, mpeg, mp4, flac, ogg, and webm.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Display name for the voice. |
| category | VoiceCategory | Yes | One of the supported voice category enum values. |
| language | string | Yes | Locale code such as en-US. |
| description | string | No | Optional text up to 1000 chars. |
| audio | binary | Yes | Source clip file (multipart/form-data). |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| data | Voice | No | Created custom voice. |
bashcURL7 lines
curl -X POST 'https://app.clariva.ai/api/v1/voices' \
-H 'Authorization: Bearer $CLARIVA_API_KEY' \
-F 'name=Team Support' \
-F 'category=customer_service' \
-F 'language=en-US' \
-F 'description=Friendly support calls.' \
-F 'audio=@./support.wav'DELETE
/api/v1/voices/{voice_id}API KeyDelete a custom voice belonging to the authenticated org.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| (empty body) | 204 No Content | No | Deletion succeeded. |
bashcURL2 lines
curl -X DELETE 'https://app.clariva.ai/api/v1/voices/voi_123' \
-H 'Authorization: Bearer $CLARIVA_API_KEY'GET
/api/v1/voices/{voice_id}/audioAPI KeyStream voice source audio as binary.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| Content-Type | audio/* | No | Original source content type. |
| Cache-Control | string | No | Private cache headers for signed asset delivery. |
bashcURL3 lines
curl -X GET 'https://app.clariva.ai/api/v1/voices/voi_123/audio' \
-H 'Authorization: Bearer $CLARIVA_API_KEY' \
--output voice.wavSearch documentation
Find pages, endpoints, and sections.