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 or get 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
channels
Channels · object | null

Channel assignments, keyed by channel.

chat
ChatSetup · object | null

With type chat: channels, follow-up, settings, which actions are on, and custom actions.

confirmation_id
string | null

The confirmation value returned by the previous publish attempt, sent back to confirm it.

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.

Required range: 0 <= x <= 30
first_speaker
string | null

First speaker returned by the Sendora API.

Pattern: ^(agent|user)$
inactivity_messages
any[] | null

Inactivity messages returned by the Sendora API.

Maximum array length: 10
inbound
Inbound · object | null

Inbound call settings: capture_leads, lead_defaults, after_hours.

is_active
boolean | null

Is active returned by the Sendora API.

join_timeout_seconds
integer | null

Join timeout seconds returned by the Sendora API.

Required range: 5 <= x <= 300
knowledge_base_ids
string[] | null

The knowledge bases this agent uses: each an id from List or get knowledge bases.

language_hint
string | null

Language hint returned by the Sendora API.

Maximum string length: 16
live
boolean | null

Chat agents only: switch the agent on or off.

max_duration_seconds
integer | null

Max duration seconds returned by the Sendora API.

Required range: x <= 3600
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.

Pattern: ^(voice|text)$
publish
boolean | null

true publishes the draft. Needs confirmation_id.

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.

test_context
TestContextValuesRequest · object | null

Voice agents: the values used for the call variables when you test the agent.

time_exceeded_message
string | null

Time exceeded message returned by the Sendora API.

Maximum string length: 600
tool_ids
string[] | null

The tools this agent uses: each an id from List or read tools and widgets (type tool).

tools
any[] | null

Tools returned by the Sendora API.

type
enum<string> | null

chat to change a chat agent's name, instructions or setup with chat. Leave out for a voice agent.

Available options:
voice,
chat
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 voices.

Maximum string length: 160
voice_id
string | null

A voice's id: the id from List 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.

Required range: 0.7 <= x <= 1.2
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

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.

channels
Channels · object

Channel assignments, keyed by email, linkedin, whatsapp, phone.

configuration
Configuration · object | null

Editable settings: prompt, voice, model, limits.

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.

inbound
Inbound · object | null

Inbound call settings.

is_active
boolean
default:false

Is active returned by the Sendora API.

knowledge_bases
Knowledge Bases · object[] | null

Knowledge bases returned by the Sendora API.

ready
boolean
default:false

Ready returned by the Sendora API.

tools
Tools · object[] | null

Tools returned by the Sendora API.

type
string
default:voice

Type returned by the Sendora API.

updated_at
string<date-time> | null

Updated at returned by the Sendora API.

voices
Voices · object[] | null

Present with include=voices.