Chatbot Operations
Get a chatbot
Returns the related information about a single chatbot. The returned chatbot schema is the same as in the /get-chatbots endpoint.
get/get-chatbot/{chatbotId}
Request
- Base URL: https://api.chat-data.com/api/v2
- URL: https://api.chat-data.com/api/v2/get-chatbot/{chatbotId}
- Auth: HTTP bearer
Path parameters
chatbotIdstring required
The unique identifier allocated to the chatbot.
Response
Successful response.
Example response
{
"chatbot": {
"chatbotId": "6650f1c2a9e4b83d2c7a1f05",
"chatbotName": "Support Bot",
"createdAt": 1791970200000,
"lastTrainedAt": 1791970200000,
"domains": [
"example.com",
"chat.example.com"
],
"disallowedUrls": [
"https://www.example.com/checkout"
],
"basePrompt": "You are a friendly support assistant for Example Inc. Answer only from the provided knowledge base and keep replies under 120 words.",
"imageDescriptionPrompt": "Describe the image in detail, including any visible text.",
"rateLimitPoints": 20,
"rateLimitTimeframe": 240,
"rateLimitMessage": "Too many messages in a row. Please wait a few minutes and try again.",
"suggestedMessages": [
"What are your opening hours?",
"How do I track my order?"
],
"initialMessages": [
"Hi! How can I help you today?"
],
"styles": {
"theme": "dark",
"buttonColor": "rgb(0, 0, 0)",
"displayName": "Support Bot",
"alignChatButton": "left",
"userMessageColor": "rgb(59, 129, 246)",
"actionButtonColor": "rgb(59, 129, 246)",
"profilePictureFile": "/storage/public/image/avatar_6650f1c2a9e4b83d2c7a1f05.png",
"bubblePictureFile": "/storage/public/image/chat_icon_6650f1c2a9e4b83d2c7a1f05.png",
"autoOpenChatWindowAfter": 3
},
"numberOfConversations": 100,
"dataSources": [
{
"name": "https://www.example.com/help/shipping",
"characters": 10000,
"type": "website"
}
],
"status": 100,
"collectedCustomerInformation": [
{
"name": "jane@chat-data.com",
"source": "widget",
"createdAt": "2026-10-14T09:30:00.000Z"
}
],
"storeChat": true,
"trackIpAddress": true,
"calendar": {
"showCalendar": true,
"calendarUrl": "https://calendly.com/jane-doe/30min",
"calendarMessage": "Book a demo"
},
"calCom": {
"showCalendar": false,
"username": "jane-doe/30min",
"calendarMessage": "Book a demo",
"hideEventTypeDetails": false,
"brandColor": "#292929",
"layout": "month"
},
"inputPlaceholderMsg": "Message...",
"enableBubbleSound": true,
"bubbleSize": 54,
"padding": {
"x": 16,
"y": 16
},
"leadsConfig": {
"message": "Let us know how to contact you.",
"collectName": true,
"collectEmail": true,
"collectPhone": false,
"nameMessage": "Name",
"emailMessage": "Email",
"phoneMessage": "Phone"
},
"notification": {
"enableLeadsEmail": true,
"leadsEmails": [
"leads1@example.com",
"leads2@example.com"
],
"enableConversationEmails": true,
"conversationEmails": [
"conversation1@example.com",
"conversation2@example.com"
]
},
"webhooks": [
{
"endpoint": "https://example.com/webhooks/chat-data",
"secret": "4f9a2c7e1b8d3f6a0c5e9b2d7a1f4c8e3b6d9f2a5c8e1b4d7f0a3c6e9b2d5f8a",
"enable": true,
"contentType": "text/plain"
}
],
"team": [
{
"userId": "6650f1c2a9e4b83d2c7a1e11",
"email": "jane@example.com",
"name": "Jane Doe",
"permissions": [
"admin",
"full",
"train",
"read"
],
"role": "Owner",
"workspaceRole": "owner",
"joinTime": "2026-10-14T09:30:00.000Z",
"source": "workspace"
}
],
"toolsParams": [],
"lastMessageAt": 1791970320000,
"customBackend": "https://bot.example.com/v1/chat",
"bearer": "cb_7d3f9a2e5c81b4f0"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.