https://api.chat-data.com/Returns the chatbots the API key can reach, with related information: every chatbot in the workspace for a workspace key, or only its own chatbot for a chatbot-scoped key.
curl 'https://api.chat-data.com/api/v2/get-chatbots' \ -H "Authorization: Bearer $CHAT_DATA_API_KEY"chatbots contains only that key's chatbot.Content type: application/json
| Field | Type | Description |
|---|---|---|
| statusstring | string | One of: success. |
| chatbotsarray of object | array of object | The list of all chatbots in your workspace. |
| chatbots | string | The unique identifier allocated to the chatbot. Use this ID in API calls about this chatbot. |
| chatbots | string | The name of the chatbot. |
| chatbots | string | The visibility of the chatbot. It controls whether your chatbot is accessible to others. One of: private, public. |
| chatbots | number | When the chatbot was created, in milliseconds since the Unix epoch. |
| chatbots | number | When the chatbot was last trained, in milliseconds since the Unix epoch. Absent if it has never been trained. |
| chatbots | boolean | Whether the chatbot can be embedded (iframe or widget) on other websites; false disables embedding. Allowed domains are set by domains. |
| chatbots | array of string | The domains on which the iframe and widget are allowed. |
| chatbots | array of string | Pages on which the chat widget is not shown. |
| chatbots | string | The base prompt (instructions) for the chatbot. |
| chatbots | string | The prompt used to describe images that users attach to their messages. |
| chatbots | number | The maximum number of messages one device can send every rateLimitTimeframe seconds. Each message counts as one here, however many message credits its model consumes. |
| chatbots | number | The time window, in seconds, to which the rateLimitPoints message limit applies. |
| chatbots | string | The error message shown to the user when the conversation is rate limited. |
| chatbots | array of string | Array of suggested messages shown in the chatbot. |
| chatbots | array of string | Array of initial messages the chatbot shows when a conversation starts. |
| chatbots | object | The appearance settings of the chat widget. |
| chatbots | string | The theme of the chatbot interface. One of: light, dark. |
| chatbots | string | The color of the chat bubble button in RGB format (e.g. rgb(0, 0, 0)). |
| chatbots | string | The display name of the chatbot. In responses, only returned when one is set. |
| chatbots | string | The alignment of the chat bubble button. One of: left, right. |
| chatbots | string | The background color of the user's messages in RGB format (e.g. rgb(59, 129, 246)). |
| chatbots | string | The color of the action buttons in RGB format (e.g. rgb(59, 129, 246)). |
| chatbots | string | URL or path of the chatbot's profile picture. Only returned when one is set. |
| chatbots | string | URL or path of the chat bubble icon. Only returned when one is set. |
| chatbots | number | The time (in seconds) after which the chat window opens automatically. A negative value disables automatic opening. |
| chatbots | string | The model the chatbot uses:
|
| chatbots | string | The large language model (OpenAI GPT, Anthropic Claude, Google Gemini or DeepSeek) used in our RAG processing pipeline. One of: gpt-4o-mini, gpt-4o, gpt-4, gpt-4.1-nano, gpt-4.1-mini, gpt-4.1, gpt-5-nano, gpt-5-mini, gpt-5, gpt-5.1, gpt-5.2, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-6-astra, gpt-6.1-sol, gpt-6-luna, gpt-5.5, gpt-5.4, gpt-5.4-nano, gpt-5.4-mini, gpt-o1, gpt-o3-mini, gpt-o3, gpt-o4-mini, claude-4-5-sonnet, claude-4-6-sonnet, claude-4-5-haiku, claude-4-opus, claude-4.1-opus, claude-4.5-opus, claude-4.6-opus, claude-5-opus, claude-5-sonnet, claude-5-5-opus, claude-5-5-sonnet, claude-5-5-haiku, gemini-3.0-flash, gemini-3.1-flash, gemini-3.5-flash-lite, gemini-3.7-flash, gemini-2.5-pro, gemini-3.0-pro, gemini-3.1-pro, deepseek-r1, deepseek-v3.2, mancer-deepseek-v4-flash. |
| chatbots | number | The number of conversations with the chatbot. |
| chatbots | array of object | A list of all data sources used to train the chatbot, along with the number of characters in each data source. |
| chatbots | string | The name of the document, the product ID or the URL of the website. Absent for plain text and Q&As. |
| chatbots | number | The total number of characters in this data source. |
| chatbots | string | The question of a q&a source. Only in the retrain-chatbot response. |
| chatbots | string | The answer of a q&a source. Only in the retrain-chatbot response. |
| chatbots | string | The folder of a q&a source, when it has one. Only in the retrain-chatbot response. |
| chatbots | string | The type of the data source (for example website, text, product or q&a). |
| chatbots | number | The training progress of the chatbot. 100 means that the training has finished. |
| chatbots | number | The temperature of the AI model, in the range [0, 1]. |
| chatbots | array of object | The customers (leads) collected by the chatbot. Use Get customers for their full details. |
| chatbots | string | One identifier of the customer: the Messenger page-scoped ID if set, otherwise the phone number, otherwise the email address, otherwise the name. |
| chatbots | string | The source the customer was acquired from (for example widget or api). |
| chatbots | string | When the customer's information was submitted (ISO 8601). |
| chatbots | boolean | Indicates whether chat history is stored on our server. All chatbot models, including medical-chat-human and medical-chat-vet, start with storage enabled by default. Storage can be disabled for any model. |
| chatbots | boolean | Indicates whether IP addresses are stored for conversations and leads. This setting works independently of chat history storage, so IP addresses can be tracked even when chat history storage is disabled. |
| chatbots | object | The Calendly booking button settings. |
| chatbots | boolean | Whether the Calendly booking button is displayed in the chatbot widget or iframe. |
| chatbots | string | The Calendly URL where users can schedule appointments. |
| chatbots | string | The label of the booking button. |
| chatbots | object | The Cal.com booking button settings. |
| chatbots | boolean | Whether the Cal.com booking button is displayed. |
| chatbots | string | The Cal.com username (or username/event path) to book with. |
| chatbots | string | The label of the booking button. |
| chatbots | boolean | Whether the event type details are hidden in the booking view. |
| chatbots | string | The brand color of the booking view. |
| chatbots | string | The layout of the booking view (for example month). |
| chatbots | string | The placeholder text of the message input. |
| chatbots | boolean | Whether the chat bubble bounces at the start of a session to attract attention. |
| chatbots | boolean | Whether a sound plays when the initial-message bubble pops up. |
| chatbots | number | The size of the chat bubble button, in pixels. |
| chatbots | object | The distance of the chat bubble from the edges of the page, in pixels. |
| chatbots | number | The horizontal distance, in pixels. |
| chatbots | number | The vertical distance, in pixels. |
| chatbots | boolean | Whether your uploaded data should be ignored when the chatbot responds. If set to true, the chatbot answers like a general-purpose AI chatbot without your knowledge base. This option applies to chatbots based on the custom-data-upload model. |
| chatbots | object | The information to be collected from potential customers. |
| chatbots | string | The message shown at the top of the customer information form. |
| chatbots | boolean | Whether the form asks for the customer's name. |
| chatbots | boolean | Whether the form asks for the customer's email address. |
| chatbots | boolean | Whether the form asks for the customer's phone number. |
| chatbots | string | The label of the name field. You can translate it into your own language. |
| chatbots | string | The label of the email field. You can translate it into your own language. |
| chatbots | string | The label of the phone field. You can translate it into your own language. |
| chatbots | object | The configuration for sending daily email notifications. |
| chatbots | boolean | Specifies whether daily email summaries about leads collected today should be sent to you. |
| chatbots | array of string | List of emails to receive information about conversations related to leads. |
| chatbots | boolean | Specifies whether daily email summaries about conversations that occurred today should be sent to you. |
| chatbots | array of string | List of emails to receive information about today's conversations. |
| chatbots | array of object | The chatbot's webhook endpoints. |
| chatbots | string | The URL endpoint that the chatbot delivers events to. |
| chatbots | array of string | An array of events that the webhook subscribes to. See Webhooks for the event bodies. |
| chatbots | string | The secret used to sign deliveries. The x-chat-data-hmac-sha256 header carries the Base64 HMAC-SHA256 of the raw request body, keyed with this secret. |
| chatbots | boolean | Indicates whether the webhook is turned on. |
| chatbots | string | The Content-Type of the deliveries. One of: text/plain, application/json. |
| chatbots | array of object | The workspace members who can access the chatbot. |
| chatbots | string | The member's user ID. |
| chatbots | string | The member's email address. |
| chatbots | string | The member's name. |
| chatbots | array of string | The member's permissions on the chatbot. |
| chatbots | string | Owner for workspace owners, otherwise Member. |
| chatbots | string | The member's workspace role. One of: owner, admin, full, train, read. |
| chatbots | string | When the member joined the workspace (ISO 8601). |
| chatbots | string | workspace when the member can access every chatbot in the workspace, chatbot when access was granted for selected chatbots. |
| chatbots | array of object | The other chatbots this chatbot can call as tools. |
| chatbots | string | The ID of the chatbot called as a tool. |
| chatbots | string | The tool name. |
| chatbots | string | When the tool is used. |
| chatbots | string | The API key used to call the chatbot. |
| chatbots | number | When the chatbot last received a message, in milliseconds since the Unix epoch. |
| chatbots | string | The URL of the chatbot's custom backend. Only returned when the chatbot uses a custom backend. |
| chatbots | string | The bearer token used to authenticate against your custom backend. Only returned when one is set. |
Example
{ "status": "success", "chatbots": [ { "chatbotId": "6650f1c2a9e4b83d2c7a1f05", "chatbotName": "Support Bot", "visibility": "private", "createdAt": 1791970200000, "lastTrainedAt": 1791970200000, "onlyAllowOnAddedDomains": true, "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 }, "model": "custom-data-upload", "baseModel": "gpt-4o-mini", "numberOfConversations": 100, "dataSources": [ { "name": "https://www.example.com/help/shipping", "characters": 10000, "type": "website" } ], "status": 100, "temperature": 0, "collectedCustomerInformation": [ { "name": "[email protected]", "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...", "enableBouncingAnimation": true, "enableBubbleSound": true, "bubbleSize": 54, "padding": { "x": 16, "y": 16 }, "ignoreDataSource": false, "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": [ "[email protected]", "[email protected]" ], "enableConversationEmails": true, "conversationEmails": [ "[email protected]", "[email protected]" ] }, "webhooks": [ { "endpoint": "https://example.com/webhooks/chat-data", "events": [ "chat" ], "secret": "4f9a2c7e1b8d3f6a0c5e9b2d7a1f4c8e3b6d9f2a5c8e1b4d7f0a3c6e9b2d5f8a", "enable": true, "contentType": "text/plain" } ], "team": [ { "userId": "6650f1c2a9e4b83d2c7a1e11", "email": "[email protected]", "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" } ]}Last updated October 14, 2026