curl --request GET \
--url https://api.getoutbox.ai/agent/{agent_id}/ \
--header 'Authorization: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "chatbot",
"tools": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"builtin_key": "<string>",
"display_name": "<string>",
"url": "<string>",
"mcp_tool": "<string>",
"method": "<string>",
"auth_token": "<string>",
"is_async": true,
"is_success": true,
"is_prerun": true,
"is_postrun": true,
"config": {},
"icon_url": "<string>",
"application_icon_url": "<string>",
"messages": [
{
"type": "<string>",
"content": "<string>"
}
],
"schema": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"required": true
}
]
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"file": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"platforms": [
{
"id": "<string>",
"platform": "<string>",
"min_delay": 123,
"max_delay": 123,
"trigger": "<string>",
"active": true
}
],
"prompt": "<string>",
"model": "gpt-4.1",
"first_message": "<string>",
"auto_follow_up_prompt": "<string>",
"advanced": {
"timezone": "<string>",
"interrupt_mode": true,
"branding_colour": "<string>"
}
}Retrieve agent details including configuration, tools, files, and platform integrations
curl --request GET \
--url https://api.getoutbox.ai/agent/{agent_id}/ \
--header 'Authorization: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "chatbot",
"tools": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"builtin_key": "<string>",
"display_name": "<string>",
"url": "<string>",
"mcp_tool": "<string>",
"method": "<string>",
"auth_token": "<string>",
"is_async": true,
"is_success": true,
"is_prerun": true,
"is_postrun": true,
"config": {},
"icon_url": "<string>",
"application_icon_url": "<string>",
"messages": [
{
"type": "<string>",
"content": "<string>"
}
],
"schema": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"required": true
}
]
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"file": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"platforms": [
{
"id": "<string>",
"platform": "<string>",
"min_delay": 123,
"max_delay": 123,
"trigger": "<string>",
"active": true
}
],
"prompt": "<string>",
"model": "gpt-4.1",
"first_message": "<string>",
"auto_follow_up_prompt": "<string>",
"advanced": {
"timezone": "<string>",
"interrupt_mode": true,
"branding_colour": "<string>"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt
Use this file to discover all available pages before exploring further.
Company API Key
The ID of the agent to retrieve
Agent details retrieved successfully
Unique identifier for the agent
Name of the agent
Agent type discriminator
chatbot Tools attached to the agent
Show child attributes
Knowledge base files attached to the agent
Show child attributes
Messaging channels and triggers this chat agent responds to
Show child attributes
Chat agent prompt
Chat model name (defaults to gpt-4.1 if empty)
First message shown in supported chat surfaces
How/when to automatically follow up if a chat goes quiet
Chat agent advanced settings
Show child attributes