Skip to main content
GET
Get Voice Details
Read only Get voice details for a voice visible to the authenticated workspace. API-key responses contain id, name, gender, provider, and accent; they do not include a preview URL or model configuration.

When To Get Voice Details

  • Voice picker UIs: render the selected voice with its name and provider badge when editing an agent.
  • Agent configuration validation: confirm the saved voice still exists and supports the language the agent is set to before publishing changes.
  • Migration tooling: when a provider deprecates a voice, look up replacements by language and gender.
For the full catalogue, use List Voices. The catalogue is paginated and supports filtering by language.

Path parameters

Errors

  • 404 Not Found is returned when the voice does not exist, is unavailable, or is not visible to this workspace.
  • 401 Unauthorized is returned when the API key is missing or revoked.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Voice ID

Example:

"voice_mfgt2k9x4q7w1z"

Response

Voice returned successfully.

id
string
name
string
gender
string
provider
string
accent
string | null