List agents
curl --request GET \
--url https://www.chatbase.co/api/v2/agents \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.chatbase.co/api/v2/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.chatbase.co/api/v2/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.chatbase.co/api/v2/agents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.chatbase.co/api/v2/agents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "5QHA6VB-DIAbBhxwqxfdi",
"name": "Support Bot",
"instructions": "<string>",
"channelInstructions": {
"chat_widget": "<string>",
"help_page": "<string>",
"center_stage": "<string>",
"side_panel": "<string>",
"slack": "<string>",
"whatsapp": "<string>",
"messenger": "<string>",
"instagram": "<string>",
"salesforce": "<string>",
"zendesk": "<string>",
"zendesk_messaging": "<string>",
"api": "<string>",
"email": "<string>",
"android_sdk": "<string>",
"ios_sdk": "<string>",
"phone": "<string>"
},
"model": "gpt-5.1",
"autoRetrain": true,
"temp": 0,
"allowedDomains": [
"<string>"
],
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"initialMessages": [
"<string>"
],
"creditLimit": 123,
"notificationsSettings": {
"dailyLeadsCollected": {
"active": true,
"emails": [
"<string>"
]
},
"dailyConversations": {
"active": true,
"emails": [
"<string>"
]
}
},
"ipRateLimits": {
"limit": 20,
"timeframe": 240,
"message": "Too many messages in a row"
},
"voiceSettings": {
"voice": {
"speed": 0.95,
"stability": 0.5,
"similarity": 0.5,
"voiceName": "<string>",
"instructions": "<string>"
},
"transcriber": {
"model": "<string>",
"language": "<string>",
"minSilenceDuration": 1.55,
"activationThreshold": 0.5
},
"recordings": {
"enabled": true,
"retentionDays": 1
},
"maxConcurrentSessions": 123,
"maxCallDurationSeconds": 123,
"maxDailyCallsPerUser": 123,
"temperature": 0.5,
"allowInterruptions": true,
"allowTextInput": true,
"endConversationAfterSilenceSeconds": 11,
"initialMessage": "<string>",
"errorMessage": "<string>"
},
"styles": {
"chat": {
"theme": "light",
"buttonColor": "<string>",
"headerColor": "<string>",
"userMessageColor": "<string>",
"displayName": "<string>",
"autoOpenChatWindowAfter": 123,
"mobile": {
"initialMessages": {
"enabled": true,
"value": [
"<string>"
]
},
"autoOpenChatWindowAfter": {
"enabled": true,
"value": 123
},
"showAutoOpen": true
},
"messagePlaceholder": "<string>",
"footer": "<string>",
"showFeedback": true,
"showCopyButton": true,
"dismissableNotice": "<string>",
"showDictation": true,
"showAttachments": true,
"showVoiceMode": true
},
"centerStage": {
"enabled": false,
"theme": "light",
"displayName": "<string>",
"welcomeMessage": "<string>",
"messagePlaceholder": "<string>",
"footer": "<string>",
"dismissableNotice": "<string>",
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"showChatBubble": true,
"showAttachments": false,
"showDictation": true,
"showVoiceMode": false,
"showCopyButton": false,
"showFeedback": true,
"showDataSource": true,
"buttonColor": "<string>",
"headerColor": "<string>",
"userMessageColor": "<string>",
"tintedGrayscale": {
"enabled": false,
"hue": 0,
"tint": 0,
"shade": 0
},
"accentColor": {
"enabled": false,
"color": "#09090B"
},
"customSurfaceColors": {
"enabled": false,
"background": "#FFFFFF",
"foreground": "#FFFFFF"
},
"typography": {
"fontFamily": "Inter",
"fontSize": "16px"
},
"width": "medium",
"closeOnOutsideClick": true,
"notificationIndicator": {
"enabled": false,
"number": 1
},
"notificationMessage": {
"enabled": false,
"text": ""
}
}
},
"createdAt": "2024-01-15T10:30:00.000Z",
"lastMessageAt": "<string>",
"lastTrainedAt": "<string>",
"status": "trained",
"size": 123
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true,
"total": 123
}
}{
"error": {
"code": "VALIDATION_INVALID_BODY",
"message": "Invalid request"
}
}{
"error": {
"code": "AUTH_MISSING_API_KEY",
"message": "Authentication required"
}
}{
"error": {
"code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
"message": "A Standard plan or higher is required to access the API"
}
}{
"error": {
"code": "RATE_LIMIT_TOO_MANY_REQUESTS",
"message": "Too many requests, please try again later"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Something went wrong, please try again"
}
}{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}Agents
List agents
Returns a paginated list of all agents for the authenticated account.
GET
/
agents
List agents
curl --request GET \
--url https://www.chatbase.co/api/v2/agents \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.chatbase.co/api/v2/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.chatbase.co/api/v2/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.chatbase.co/api/v2/agents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.chatbase.co/api/v2/agents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "5QHA6VB-DIAbBhxwqxfdi",
"name": "Support Bot",
"instructions": "<string>",
"channelInstructions": {
"chat_widget": "<string>",
"help_page": "<string>",
"center_stage": "<string>",
"side_panel": "<string>",
"slack": "<string>",
"whatsapp": "<string>",
"messenger": "<string>",
"instagram": "<string>",
"salesforce": "<string>",
"zendesk": "<string>",
"zendesk_messaging": "<string>",
"api": "<string>",
"email": "<string>",
"android_sdk": "<string>",
"ios_sdk": "<string>",
"phone": "<string>"
},
"model": "gpt-5.1",
"autoRetrain": true,
"temp": 0,
"allowedDomains": [
"<string>"
],
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"initialMessages": [
"<string>"
],
"creditLimit": 123,
"notificationsSettings": {
"dailyLeadsCollected": {
"active": true,
"emails": [
"<string>"
]
},
"dailyConversations": {
"active": true,
"emails": [
"<string>"
]
}
},
"ipRateLimits": {
"limit": 20,
"timeframe": 240,
"message": "Too many messages in a row"
},
"voiceSettings": {
"voice": {
"speed": 0.95,
"stability": 0.5,
"similarity": 0.5,
"voiceName": "<string>",
"instructions": "<string>"
},
"transcriber": {
"model": "<string>",
"language": "<string>",
"minSilenceDuration": 1.55,
"activationThreshold": 0.5
},
"recordings": {
"enabled": true,
"retentionDays": 1
},
"maxConcurrentSessions": 123,
"maxCallDurationSeconds": 123,
"maxDailyCallsPerUser": 123,
"temperature": 0.5,
"allowInterruptions": true,
"allowTextInput": true,
"endConversationAfterSilenceSeconds": 11,
"initialMessage": "<string>",
"errorMessage": "<string>"
},
"styles": {
"chat": {
"theme": "light",
"buttonColor": "<string>",
"headerColor": "<string>",
"userMessageColor": "<string>",
"displayName": "<string>",
"autoOpenChatWindowAfter": 123,
"mobile": {
"initialMessages": {
"enabled": true,
"value": [
"<string>"
]
},
"autoOpenChatWindowAfter": {
"enabled": true,
"value": 123
},
"showAutoOpen": true
},
"messagePlaceholder": "<string>",
"footer": "<string>",
"showFeedback": true,
"showCopyButton": true,
"dismissableNotice": "<string>",
"showDictation": true,
"showAttachments": true,
"showVoiceMode": true
},
"centerStage": {
"enabled": false,
"theme": "light",
"displayName": "<string>",
"welcomeMessage": "<string>",
"messagePlaceholder": "<string>",
"footer": "<string>",
"dismissableNotice": "<string>",
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"showChatBubble": true,
"showAttachments": false,
"showDictation": true,
"showVoiceMode": false,
"showCopyButton": false,
"showFeedback": true,
"showDataSource": true,
"buttonColor": "<string>",
"headerColor": "<string>",
"userMessageColor": "<string>",
"tintedGrayscale": {
"enabled": false,
"hue": 0,
"tint": 0,
"shade": 0
},
"accentColor": {
"enabled": false,
"color": "#09090B"
},
"customSurfaceColors": {
"enabled": false,
"background": "#FFFFFF",
"foreground": "#FFFFFF"
},
"typography": {
"fontFamily": "Inter",
"fontSize": "16px"
},
"width": "medium",
"closeOnOutsideClick": true,
"notificationIndicator": {
"enabled": false,
"number": 1
},
"notificationMessage": {
"enabled": false,
"text": ""
}
}
},
"createdAt": "2024-01-15T10:30:00.000Z",
"lastMessageAt": "<string>",
"lastTrainedAt": "<string>",
"status": "trained",
"size": 123
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true,
"total": 123
}
}{
"error": {
"code": "VALIDATION_INVALID_BODY",
"message": "Invalid request"
}
}{
"error": {
"code": "AUTH_MISSING_API_KEY",
"message": "Authentication required"
}
}{
"error": {
"code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
"message": "A Standard plan or higher is required to access the API"
}
}{
"error": {
"code": "RATE_LIMIT_TOO_MANY_REQUESTS",
"message": "Too many requests, please try again later"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Something went wrong, please try again"
}
}{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}Authorizations
API key from your account settings
Query Parameters
Opaque cursor from a previous response to fetch the next page
Example:
"eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="
Number of items per page (1–100, default 20)
Required range:
1 <= x <= 100Example:
20
⌘I
