Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Use GET /api/v1/ai-agents to list all AI agents configured in your ChatbotX workspace, including model settings, system prompts, and enabled tools.
/api/v1/ai-agentscurl --request GET \
--url https://app.chatbotx.io/api/v1/ai-agents \
--header 'Authorization: Bearer <token>'
import requests
url = "https://app.chatbotx.io/api/v1/ai-agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())
const options = {
method: 'GET',
headers: { Authorization: 'Bearer <token>' }
};
fetch('https://app.chatbotx.io/api/v1/ai-agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
200 OK with a data array of AI agent objects and a pageCount.
Show data item fields
gpt-4o, claude-3-5-sonnet).web_search, contact_lookup).true, this agent is the default AI agent for the workspace.{
"data": [
{
"id": "agent_001",
"name": "Support Bot",
"prompt": "You are a helpful customer support agent for Acme Corp. Answer questions about products and orders. Escalate to a human if the user is frustrated.",
"models": ["gpt-4o"],
"tools": ["web_search", "contact_lookup"],
"webSearchAuthorizedDomains": ["acme.com", "docs.acme.com"],
"messages": [],
"isDefault": true,
"temperature": 0.3,
"maxOutputTokens": 1024,
"workspaceId": "42",
"createdAt": "2024-01-05T10:00:00Z",
"updatedAt": "2024-04-20T14:30:00Z"
}
],
"pageCount": 1
}