Get Live

Custom voices

Create a custom voice

post/v1/custom-voices

Creates 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/json
  • namestringRequired
  • audioPathstringRequired

    Absolute path to an audio or video file on this machine (up to 200 MB) with at least 5 seconds of clear speech

  • imagePathstring

    Optional absolute path to an avatar image (up to 20 MB), cropped to a square

Responses

200Custom voice created
  • okbooleanRequired
  • voiceCustomVoiceRequired
    3 child fields
    • idstringRequired

      Voice ID for POST /v1/voice and DELETE /v1/custom-voices/{id}

    • namestringRequired
    • imageUrlstring or nullRequired

      Avatar URL, or null when the voice has no image

400Invalid fields, a missing or unreadable file, or audio without enough clear speech
  • okbooleanRequired
  • errorstring

    Present only when ok is false

401Invalid or missing API key
  • errorstringRequired

    Error message

403The account needs an active subscription
  • okbooleanRequired
  • errorstring

    Present only when ok is false

409The account has reached its custom voice limit
  • okbooleanRequired
  • errorstring

    Present only when ok is false

503The desktop app is not signed in
  • okbooleanRequired
  • errorstring

    Present only when ok is false

504The desktop app did not finish the request in time
  • okbooleanRequired
  • errorstring

    Present only when ok is false