TextToSpeech

Get voice preview

Returns a short audio preview for an existing voice. The preview text is determined server-side and cannot be customized. This endpoint is not metered or billed, making it ideal for voice browsing and selection experiences. Audio is always returned in MP3 format.

GET/tts/v1/voice:preview

Authorizations

Authorizationstringrequired

Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Query Parameters

voice_idstringrequired

The identifier of the voice to preview. Use the List Voices endpoint to discover available voice IDs.

model_idstringrequired

The identifier of the TTS model to use for generating the preview. See Models for available models.

Response

200 - application/json

audioContentstring

The audio data bytes encoded as MP3. The preview text is determined server-side and cannot be customized.

Get voice preview

curl 'https://api.inworld.ai/tts/v1/voice:preview?voice_id=Ashley&model_id=inworld-tts-2' \
--header "Authorization: Basic $INWORLD_API_KEY" \
| jq -r '.audioContent' | base64 -d > preview.mp3

successful_response

{
  "audioContent": "SUQzBAAAAAAAI1RTU0UAAAAPAAADTGF2ZjYwLjE2LjEwMAAAAAAAAAAAAAAA..."
}