Custom voices
Create a custom voice
/v1/custom-voicesCreates a custom voice from a local audio or video file, the same way as the in-app recorder: the app converts the file and keeps the clearest 5 to 15 seconds of speech. Needs an active subscription and a signed-in desktop app. Long videos can take up to a minute; requests time out after three minutes.
The new voice is in GET /v1/voices and GET /v1/custom-voices when
this returns, and can be selected with POST /v1/voice.
Request body
application/jsonnamestringRequiredaudioPathstringRequiredAbsolute path to an audio or video file on this machine (up to 200 MB) with at least 5 seconds of clear speech
imagePathstringOptional absolute path to an avatar image (up to 20 MB), cropped to a square
Responses
200Custom voice created
okbooleanRequiredvoiceCustomVoiceRequired3 child fields
idstringRequiredVoice ID for
POST /v1/voiceandDELETE /v1/custom-voices/{id}namestringRequiredimageUrlstring or nullRequiredAvatar URL, or null when the voice has no image
400Invalid fields, a missing or unreadable file, or audio without enough clear speech
okbooleanRequirederrorstringPresent only when
okisfalse
401Invalid or missing API key
errorstringRequiredError message
403The account needs an active subscription
okbooleanRequirederrorstringPresent only when
okisfalse
409The account has reached its custom voice limit
okbooleanRequirederrorstringPresent only when
okisfalse
503The desktop app is not signed in
okbooleanRequirederrorstringPresent only when
okisfalse
504The desktop app did not finish the request in time
okbooleanRequirederrorstringPresent only when
okisfalse