Skip to main content
GET
Get Agent

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

The id of an agent. This is returned on agent creation.

Example:

"agent_4m8q7z2pxn5r9vkt6d3h1c0b"

Query Parameters

version_id
string | null

The ID of the agent version to use

Example:

"agtvrsn_8901k4t9z5defmb8vh3e9361y7nj"

branch_id
string | null

The ID of the branch to use

Example:

"agtbrch_0901k4aafjxxfxt93gd841r7tv5t"

Response

Successful Response

agent_id
string
required

The ID of the agent

name
string
required

The name of the agent

conversation_config
ConversationalConfigAPIModel · object
required

The conversation configuration of the agent

metadata
AgentMetadataResponseModel · object
required

The metadata of the agent

platform_settings
AgentPlatformSettingsResponseModel · object

The platform settings of the agent

phone_numbers
(GetPhoneNumberManagedPSTNResponseModel · object | GetPhoneNumberSIPTrunkResponseModel · object)[]

The phone numbers of the agent

Example:
whatsapp_accounts
GetWhatsAppAccountResponse · object[]

WhatsApp accounts assigned to the agent

workflow
AgentWorkflowResponseModel · object

The workflow of the agent

Example:
access_info
ResourceAccessInfo · object | null

The access information of the agent for the user

Example:
tags
string[]

Agent tags used to categorize the agent

version_id
string | null

The ID of the version the agent is on

branch_id
string | null

The ID of the branch the agent is on

main_branch_id
string | null

The ID of the main branch for this agent