curl --request GET \
--url https://www.chatbase.co/api/v2/agents/{agentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}"
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/{agentId}', 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/{agentId}",
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/{agentId}"
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/{agentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}")
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{
"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>",
"search": "<string>"
},
"model": "gpt-5.6-terra",
"autoRetrain": true,
"temp": 0,
"visibility": "public",
"allowedDomains": [
"<string>"
],
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"initialMessages": [
"<string>"
],
"creditLimit": 123,
"creditsUsed": 1284,
"notificationsSettings": {
"dailyLeadsCollected": {
"active": true,
"emails": [
"<string>"
]
},
"dailyConversations": {
"active": true,
"emails": [
"<string>"
]
}
},
"ipRateLimits": {
"limit": 20,
"timeframe": 240,
"message": "Too many messages in a row"
},
"spamSettings": {
"enabled": true,
"prompt": "<string>"
},
"blockedCountries": [
"RU",
"KP"
],
"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,
"model": "gpt-4o",
"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
},
"alignChatButton": "left",
"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,
"headerColor": "<string>",
"userMessageColor": "<string>",
"tintedGrayscale": {
"enabled": false,
"hue": 0,
"tint": 4.5,
"shade": 0
},
"accentColorEnabled": true,
"accentSyncWithIcon": true,
"typography": {
"fontFamily": "Inter",
"fontSize": "16px"
},
"closeOnOutsideClick": true
}
},
"createdAt": "2024-01-15T10:30:00.000Z",
"lastMessageAt": "<string>",
"lastTrainedAt": "<string>",
"status": "trained",
"size": 123
}{
"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": "AGENT_NOT_FOUND",
"message": "Agent not found"
}
}{
"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"
}
}Get agent
Returns a single agent by ID.
curl --request GET \
--url https://www.chatbase.co/api/v2/agents/{agentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}"
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/{agentId}', 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/{agentId}",
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/{agentId}"
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/{agentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}")
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{
"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>",
"search": "<string>"
},
"model": "gpt-5.6-terra",
"autoRetrain": true,
"temp": 0,
"visibility": "public",
"allowedDomains": [
"<string>"
],
"suggestedMessages": [
{
"text": "<string>",
"type": "single",
"order": 123,
"icon": "<string>"
}
],
"initialMessages": [
"<string>"
],
"creditLimit": 123,
"creditsUsed": 1284,
"notificationsSettings": {
"dailyLeadsCollected": {
"active": true,
"emails": [
"<string>"
]
},
"dailyConversations": {
"active": true,
"emails": [
"<string>"
]
}
},
"ipRateLimits": {
"limit": 20,
"timeframe": 240,
"message": "Too many messages in a row"
},
"spamSettings": {
"enabled": true,
"prompt": "<string>"
},
"blockedCountries": [
"RU",
"KP"
],
"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,
"model": "gpt-4o",
"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
},
"alignChatButton": "left",
"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,
"headerColor": "<string>",
"userMessageColor": "<string>",
"tintedGrayscale": {
"enabled": false,
"hue": 0,
"tint": 4.5,
"shade": 0
},
"accentColorEnabled": true,
"accentSyncWithIcon": true,
"typography": {
"fontFamily": "Inter",
"fontSize": "16px"
},
"closeOnOutsideClick": true
}
},
"createdAt": "2024-01-15T10:30:00.000Z",
"lastMessageAt": "<string>",
"lastTrainedAt": "<string>",
"status": "trained",
"size": 123
}{
"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": "AGENT_NOT_FOUND",
"message": "Agent not found"
}
}{
"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
Path Parameters
The agent ID
1"5QHA6VB-DIAbBhxwqxfdi"
Response
Agent details
Agent ID
"5QHA6VB-DIAbBhxwqxfdi"
Agent name
"Support Bot"
System prompt / instructions for the agent
Per-channel instruction overrides
Show child attributes
Show child attributes
AI model used by the agent. Can be a deprecated model for agents that were configured before it was retired.
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, auto "gpt-5.6-terra"
Whether the agent automatically retrains every 7 days
Model temperature (0–1)
0 <= x <= 10
Whether the agent is publicly accessible or private
public, private Domains allowed to embed this agent
Suggested quick-reply messages shown to users
- Option 1
- Option 2
Show child attributes
Show child attributes
Initial messages shown when a conversation starts
Per-agent credit limit (null = no limit)
Credits consumed by this agent since the start of the current calendar month (UTC). Resets to 0 on the 1st of each month.
1284
Email notification settings including recipient addresses
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Spam detection settings. When enabled, conversations are checked for spam and automatically paused.
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country codes blocked from accessing this agent. Visitors from these countries will not see the chatbot.
["RU", "KP"]
Voice mode settings
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ISO 8601 creation timestamp
"2024-01-15T10:30:00.000Z"
ISO 8601 timestamp of the last received message
ISO 8601 timestamp of the last completed training
Training state derived from the agent's sources. untrained: no live sources. training: at least one source is still being processed. failed: a source failed to train (the others are live). trained: every source is live.
untrained, training, failed, trained "trained"
Total size of training data in bytes
