Get Live

Voice

Select a voice

post/v1/voice

Sets the active voice by its ID. Use GET /v1/voices to list available voice IDs, or GET /v1/custom-voices for your custom voices.

If the voice model is not yet downloaded locally, it will be downloaded automatically. This may take a few seconds on the first call for a given voice.

Effects such as Clean Mic and Robot have nothing to download. While the voice changer runs, switching between an effect and an AI voice restarts it; within one kind it switches live.

Request body

application/json
  • idstringRequired

    Voice ID from the voice library

Responses

200Voice set successfully
  • okbooleanRequired
  • errorstring

    Present only when ok is false

400Invalid body, or the voice model could not be downloaded or applied
  • okbooleanRequired
  • errorstring

    Present only when ok is false

401Invalid or missing API key
  • errorstringRequired

    Error message

404Voice ID not found in the library
  • errorstringRequired

    Error message

503The desktop app is not signed in
  • errorstringRequired

    Error message