Skip to main content
GET
Get an agent's voice

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

Response

Successful Response

How an agent sounds and what it listens for.

agent_id
string
required

The agent's ID.

background_sound
string
required

Ambient sound played behind the voice. Known values: off, office, soft_office. More can be added, so handle values you don't recognize.

background_volume
number
required

The background sound volume, from 0 to 1.

languages
string[] | null
required

The languages the agent listens for, as language codes such as en or es. null when none is chosen: the transcriber's default languages apply.

object
string
default:agent_voice
required

The type of this object, always agent_voice.

Allowed value: "agent_voice"
pronunciations
Pronunciation · object[]
required

How the agent should say particular words.

speed
number
required

How fast the voice speaks, where 1.0 is its natural pace.

transcription_keywords
string[]
required

Words the agent listens for especially closely, such as names or product terms.

voice_id
string | null
required

The voice the agent speaks with. null when none is chosen.