Skip to main content
GET
Get Agent

Authorizations

Authorization
string
header
required

Company API Key

Path Parameters

agent_id
string
required

The ID of the agent to retrieve

Response

Agent details retrieved successfully

id
string<uuid>
required

Unique identifier for the agent

name
string
required

Name of the agent

type
enum<string>
required

Agent type discriminator

Available options:
chatbot
tools
object[]
required

Tools attached to the agent

files
object[]
required

Knowledge base files attached to the agent

platforms
object[]

Messaging channels and triggers this chat agent responds to

prompt
string

Chat agent prompt

model
string
default:gpt-4.1

Chat model name (defaults to gpt-4.1 if empty)

first_message
string

First message shown in supported chat surfaces

auto_follow_up_prompt
string

How/when to automatically follow up if a chat goes quiet

advanced
object

Chat agent advanced settings