Endpoints
Widget Config
Retrieve chatbot widget configuration for embedding
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve chatbot widget configuration for embedding
GET /api/widget/config
| Parameter | Type | Required | Description |
|---|---|---|---|
chatbot_id | string | Yes | The chatbot ID |
| Header | Value | Required |
|---|---|---|
Authorization | Bearer tb_your-api-key | Yes |
{
"chatbot_id": "cb_abc123",
"agent_id": "agent_def456",
"name": "Storefront Assistant",
"config": {
"welcome_message": "Hi there! How can I help you today?",
"suggested_prompts": [
"What's new this week?",
"Help me find running shoes",
"Track my order",
"What's your return policy?"
],
"theme": {
"primary_color": "#303030",
"background_color": "#FFFFFF",
"text_color": "#1A1A1A",
"user_message_color": "#303030",
"bot_message_color": "#F3F4F6"
},
"bubble_style": "rounded",
"position": "bottom-right",
"title": "Support",
"subtitle": "We typically reply instantly"
}
}
| Field | Type | Description |
|---|---|---|
chatbot_id | string | Unique chatbot identifier |
agent_id | string | The agent powering this chatbot |
name | string | Internal chatbot name |
config.welcome_message | string | Initial message shown to visitors |
config.suggested_prompts | array | Clickable prompt suggestions |
config.theme | object | Color configuration |
config.bubble_style | string | rounded, square, or pill |
config.position | string | bottom-right or bottom-left |
config.title | string | Chat window header title |
config.subtitle | string | Optional subtitle text |
| Status | Description |
|---|---|
400 | Missing chatbot_id parameter |
401 | Invalid or missing API key |
404 | Chatbot not found |
500 | Internal server error |
<script
src="https://your-store.toebox.ai/embed/chatbot.js"
data-chatbot-id="cb_abc123"
async
></script>