Skip to main content
PATCH
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

agent_id
string
required

The voice agent's id: the id from List voice agents. It is also the last part of that page's address in the app.

Body

application/json
avatar_url
string | null

Avatar url returned by the Sendora API.

Maximum string length: 500
avatar_video_url
string | null

Avatar video url returned by the Sendora API.

Maximum string length: 500
custom_voice_ref
string | null

Custom voice ref returned by the Sendora API.

display_name
string | null

Display name returned by the Sendora API.

Maximum string length: 200
first_message
string | null

First message returned by the Sendora API.

Maximum string length: 2000
first_message_delay_seconds
number | null

First message delay seconds returned by the Sendora API.

first_speaker
string | null

First speaker returned by the Sendora API.

inactivity_messages
any[] | null

Inactivity messages returned by the Sendora API.

is_active
boolean | null

Is active returned by the Sendora API.

join_timeout_seconds
integer | null

Join timeout seconds returned by the Sendora API.

language_hint
string | null

Language hint returned by the Sendora API.

Maximum string length: 16
max_duration_seconds
integer | null

Max duration seconds returned by the Sendora API.

model
string | null

Model returned by the Sendora API.

name
string | null

Name returned by the Sendora API.

Maximum string length: 200
output_medium
string | null

Output medium returned by the Sendora API.

recording_enabled
boolean | null

Recording enabled returned by the Sendora API.

system_prompt
string | null

System prompt returned by the Sendora API.

Maximum string length: 20000
temperature
number | null

Temperature returned by the Sendora API.

time_exceeded_message
string | null

Time exceeded message returned by the Sendora API.

tools
any[] | null

Tools returned by the Sendora API.

uninterruptible
boolean | null

Uninterruptible returned by the Sendora API.

voice_asset_id
string | null

The voice to use: the asset_id of a voice in List agent voice choices.

Maximum string length: 160
voice_id
string | null

A voice's id: the id from List available voices.

Maximum string length: 128
voice_model
string | null

Voice model returned by the Sendora API.

voice_speed
number | null

Voice speed returned by the Sendora API.

voicemail_enabled
boolean | null

Voicemail enabled returned by the Sendora API.

voicemail_script
string | null

Voicemail script returned by the Sendora API.

Maximum string length: 600

Response

Successful Response

Deliberately minimal public representation of a voice agent.

The authenticated operator API returns the full configuration, but public API keys must not receive system prompts, tool definitions, tenant IDs, or connected service resource identifiers as an incidental side effect of listing an agent. Configuration is accepted on write requests but is never echoed.

created_at
string<date-time>
required

Created at returned by the Sendora API.

id
string
required

The voice agent's id. Pass it to any endpoint that takes agent_id.

name
string
required

Name returned by the Sendora API.

direction
string
default:outbound

Direction returned by the Sendora API.

display_name
string | null

Display name returned by the Sendora API.

first_message
string
default:""

First message returned by the Sendora API.

is_active
boolean
default:false

Is active returned by the Sendora API.

ready
boolean
default:false

Ready returned by the Sendora API.

updated_at
string<date-time> | null

Updated at returned by the Sendora API.