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

Query Parameters

purpose
enum<string>
required

What the image is for.

Available options:
agent_avatar,
widget_avatar,
widget_launcher
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. The agent the image belongs to.

widget_id
string | null

The widget's id: the id from List or read tools and widgets (type widget) for this agent. Needed for widget_avatar and widget_launcher.

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.