Skip to main content
GET
Get Agent

Authorizations

x-api-key
string
header
required

API key for programmatic access

Path Parameters

agent_id
string
required

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

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 | null

The platform settings of the agent

phone_numbers
AgentPhoneNumberResponseModel · object[]

The phone numbers of the agent

workflow
AgentWorkflowResponseModel · object | null

The workflow of the agent

access_info
ResourceAccessInfo · object | null

Access information for the user

tags
string[]

Agent tags for categorization