Skip to main content
GET
Get Agent by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required

Response

Agent details

Full agent details returned by GET /agent/{agent_id}. Contains metadata, current config, prompts and optional knowledgebase linkage.

agent_id
string<uuid>
required

Agent UUID.

account_id
string<uuid>
required

Account UUID owning the agent.

name
string
required

Agent display name.

agent_config
object
required

The full agent configuration object as submitted on create/update.

agent_type
string

Logical agent type (e.g., 'other').

call_direction
string

Call direction: 'inbound' or 'outbound'.

inbound_phone_number
string | null

Configured inbound phone number (E.164) if agent is inbound.

agent_image
string | null

URL to agent image or avatar.

webhook_url
string<uri> | null

Webhook URL where events will be posted.

total_calls
integer

Total number of calls handled by this agent.

total_duration
integer

Aggregate call duration in seconds.

total_cost
number<float>

Aggregated cost for calls (currency depending on account).

created_at
string<date-time>

Agent creation timestamp (ISO 8601).

timezone
string

Timezone of the agent (IANA zone).

country
string

Two-letter country code for agent defaults.

template_variables
object

Template variables available to prompts and calls.

is_compliant
boolean

Whether the agent is flagged as compliance-restricted (affects recording, etc.).

agent_prompts
object

Map of prompt IDs to prompt objects.

knowledgebase
object | null

Optional knowledgebase linkage for retrieval-enabled agents.