Skip to main content
GET
Get Agent Details

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Path Parameters

agent_id
string
required
Required string length: 24

Response

Successful Response

id
string
required
account_id
string
required
name
string
required
voice_audio_id
string
required
roles
RoleModel · object[]
required
personality
PersonalityModel · object
required

Describes the personality of an agent. These values will be injected into the agent's prompt. LLM might use them to adjust the agent's responses.

enabled
boolean
required
avatar
string | null
actions
ActionModel · object[] | null
scripts
ScriptModel · object[] | null
script
ScriptModel · object | null
deprecated

Container for a single script record.

Example:
knowledge_base_ids
string[] | null
greetings
string[] | null
interruptions
string[] | null
history
HistoryModel · object | null
greeting_type_inbound
enum<string> | null
Available options:
static,
ai,
none
greeting_type_outbound
enum<string> | null
Available options:
static,
ai,
none
structured_greetings
StructuredGreetingModel · object[] | null
tts_settings
TTSSettings · object | null