Skip to main content
POST
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

Body

application/json
direction
string
default:outbound

'outbound' (places calls) or 'inbound' (answers calls on assigned numbers)

first_message
string
default:""

Opening words spoken by the agent at call start

Maximum string length: 2000
first_message_delay_seconds
number | null

First message delay seconds returned by the Sendora API.

first_speaker
string
default:agent

'agent' or 'user'

inactivity_messages
any[] | null

Inactivity messages returned by the Sendora API.

join_timeout_seconds
integer | null

Join timeout seconds returned by the Sendora API.

language_hint
string
default:en

BCP-47 language hint, e.g. 'en', 'de', 'es'

Maximum string length: 16
max_duration_seconds
integer
default:300

Max duration seconds returned by the Sendora API.

model
string
default:voice service-v0.6

Model returned by the Sendora API.

name
string
default:New Agent

Name returned by the Sendora API.

Maximum string length: 200
output_medium
string
default:voice

'voice' or 'text'

recording_enabled
boolean
default:true

Recording enabled returned by the Sendora API.

system_prompt
string
default:You are a professional AI sales development representative making outbound calls.

System prompt returned by the Sendora API.

Maximum string length: 20000
temperature
number
default:0.7

Temperature returned by the Sendora API.

time_exceeded_message
string | null

Time exceeded message returned by the Sendora API.

tools
any[] | null

voice service tool definitions (JSONB)

uninterruptible
boolean
default:false

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
default:""

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

Maximum string length: 128
voicemail_enabled
boolean
default:false

Drop a voicemail when a call this agent places reaches voicemail

voicemail_script
string | null

Spoken live when voicemail is detected; supports {{lead.*}} and {{ai:...}} tokens

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.