Skip to main content
GET
Get agent

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Response

Agent details

id
string
required

Agent ID

Example:

"5QHA6VB-DIAbBhxwqxfdi"

name
string
required

Agent name

Example:

"Support Bot"

instructions
string
required

System prompt / instructions for the agent

channelInstructions
object | null
required

Per-channel instruction overrides

model
enum<string>
required

AI model used by the agent

Available options:
gpt-4o,
gpt-4o-mini,
o4-mini,
gpt-oss-120b,
gpt-oss-20b,
gpt-5,
gpt-5.1,
gpt-5.2,
gpt-5.4,
gpt-5.4-mini,
gpt-5.4-nano,
gpt-5.5,
gpt-5.6-terra,
gpt-5.6-luna,
gpt-5-mini,
gpt-5-nano,
claude-opus-4-8,
claude-opus-4-7,
claude-opus-4-6,
claude-sonnet-4-6,
claude-opus-4-5,
claude-haiku-4-5,
claude-sonnet-4-5,
gemini-2.5-pro,
gemini-3-flash,
gemini-3.1-flash-lite,
gemini-3.1-pro,
gemini-3.5-flash,
gemini-3.5-flash-lite,
gemini-3.6-flash,
grok-3,
grok-3-mini,
grok-4,
DeepSeek-V3,
DeepSeek-R1,
DeepSeek-V4-Flash,
Llama-4-Scout-17B-16E-Instruct,
Llama-4-Maverick-17B-128E-Instruct-FP8,
kimi-k2,
mistral-medium-3.5,
mistral-small-2603,
glm-5.2
Example:

"gpt-5.1"

autoRetrain
boolean
required

Whether the agent automatically retrains every 7 days

temp
number
required

Model temperature (0–1)

Required range: 0 <= x <= 1
Example:

0

visibility
enum<string>
required

Whether the agent is publicly accessible or private

Available options:
public,
private
allowedDomains
string[] | null
required

Domains allowed to embed this agent

suggestedMessages
object[] | null
required

Suggested quick-reply messages shown to users

initialMessages
string[]
required

Initial messages shown when a conversation starts

creditLimit
integer | null
required

Per-agent credit limit (null = no limit)

notificationsSettings
object | null
required

Email notification settings including recipient addresses

ipRateLimits
object
required
voiceSettings
object | null
required

Voice mode settings

styles
object | null
required
createdAt
string
required

ISO 8601 creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

lastMessageAt
string | null
required

ISO 8601 timestamp of the last received message

lastTrainedAt
string | null
required

ISO 8601 timestamp of the last completed training

status
string | null
required

Current training status of the agent

Example:

"trained"

size
number
required

Total size of training data in bytes