Sign in
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 Key

List system and organization voices visible to the API key.

Query Parameters

FieldTypeRequiredDescription
querystringNoOptional case-insensitive search over voice name and description.

Response

FieldTypeRequiredDescription
data[]VoiceNoArray of system and custom voices.
data[].variantSYSTEM | CUSTOMNoIndicates whether voice is global or org-owned.
data[].sample_promptstring | nullNoIncluded 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/systemPublic

List public system voices without authentication.

Response

FieldTypeRequiredDescription
data[]VoiceNoPublic system catalog only.
bashcURL1 lines
curl -X GET 'https://app.clariva.ai/api/v1/voices/system'
GET/api/v1/voices/{voice_id}API Key

Fetch one voice by id.

Response

FieldTypeRequiredDescription
dataVoiceNoSingle 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 Key

Create a custom org-owned voice via multipart upload.

Audio supports wav, mpeg, mp4, flac, ogg, and webm.

Request Body

FieldTypeRequiredDescription
namestringYesDisplay name for the voice.
categoryVoiceCategoryYesOne of the supported voice category enum values.
languagestringYesLocale code such as en-US.
descriptionstringNoOptional text up to 1000 chars.
audiobinaryYesSource clip file (multipart/form-data).

Response

FieldTypeRequiredDescription
dataVoiceNoCreated 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 Key

Delete a custom voice belonging to the authenticated org.

Response

FieldTypeRequiredDescription
(empty body)204 No ContentNoDeletion 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 Key

Stream voice source audio as binary.

Response

FieldTypeRequiredDescription
Content-Typeaudio/*NoOriginal source content type.
Cache-ControlstringNoPrivate 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.wav

Search documentation

Find pages, endpoints, and sections.