Voices

Voices are the speech synthesis identities your agents speak with. The platform maintains a catalogue of voices; you select one by setting configuration.tts.voice_id on an agent.

The voice catalogue

List available voices:

curl https://api.simwood.com/convai/v1/voices \
  -H "Authorization: Bearer sk_live_..."

Each voice has:

Property	Type	Description
`id`	string (UUID)	The ID to use in `configuration.tts.voice_id`
`name`	string	Display name
`category`	string	Voice category (e.g. `premade`, `professional`)
`description`	string	A short description of the voice's character
`preview_url`	string	URL to an audio sample
`labels`	object	Key-value metadata (e.g. `{"accent": "british", "gender": "female"}`)
`tags`	string[]	Searchable tags
`status`	string	`active` or `inactive`

By default only active voices are returned. Pass ?include_inactive=true to see inactive voices — useful when an existing agent references a voice that has been retired.

Selecting a voice

List voices and browse name, description, and labels to narrow down candidates.
Use preview_url to listen to a sample.
Copy the id of your chosen voice.
Set it as configuration.tts.voice_id when creating or updating an agent.

# Retrieve a specific voice
curl https://api.simwood.com/convai/v1/voices/<voice-id> \
  -H "Authorization: Bearer sk_live_..."

Voice settings

In addition to selecting a voice, you can tune how it sounds with configuration.tts.settings:

Setting	Range	Effect
`stability`	0–1	Lower values produce more expressive, variable speech; higher values are more consistent and measured
`similarity_boost`	0–1	How closely the output resembles the target voice; lower values add more variety
`speed`	0.5–2.0	Relative playback speed; `1.0` is natural pace

Voice settings interact with each other. A starting point of stability: 0.5, similarity_boost: 0.75, speed: 1.0 works well for most use cases — adjust from there based on listening tests.

AgentsHow voice_id and TTS settings fit into the full agent configuration.

Agents

Knowledge base