Skip to content

Create Voice

POST
/v1/voices
curl --request POST \
--url https://example.com/v1/voices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "gender": "example", "referenceAudioBase64": "example", "referenceTranscript": "example", "languages": [ "example" ], "vibeTags": [ "example" ] }'
Media typeapplication/json
CreateVoiceRequest
object
name
required
Name
string
>= 1 characters <= 120 characters
gender
required
Gender

One of: male, female, neutral

string
referenceAudioBase64
required
Referenceaudiobase64

Reference clone audio, base64-encoded WAV

string
>= 1 characters
referenceTranscript
required
Referencetranscript

Exact transcript spoken in the reference audio

string
>= 1 characters <= 2000 characters
languages
Languages
Array<string>
vibeTags
Vibetags
Array<string>
<= 12 items
Examplegenerated
{
"name": "example",
"gender": "example",
"referenceAudioBase64": "example",
"referenceTranscript": "example",
"languages": [
"example"
],
"vibeTags": [
"example"
]
}

Successful Response

Media typeapplication/json
VoiceResponse
object
id
required
Id
string
name
required
Name
string
provider
required
Provider
string
gender
required
Gender
string
supportedLanguages
required
Supportedlanguages
Array<string>
vibeTags
required
Vibetags
Array<string>
isCustom
required
Iscustom
boolean
isDefault
required
Isdefault
boolean
sampleAudioUrl
Any of:
string
Examplegenerated
{
"id": "example",
"name": "example",
"provider": "example",
"gender": "example",
"supportedLanguages": [
"example"
],
"vibeTags": [
"example"
],
"isCustom": true,
"isDefault": true,
"sampleAudioUrl": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}