Skip to main content
GET
/
chatbot
/
{id}
Get a specific chatbot
curl --request GET \
  --url https://api.cleartalk.ai/chatbot/{id} \
  --header 'x-api-key: <api-key>'
{
  "chatbotName": "<string>",
  "chatbot_title": "<string>",
  "header_color": "#000000",
  "background_color": "#FFFFFF",
  "pathway_id": "<string>",
  "text_color": "#000000",
  "welcome_message": "Hi! How can I help you today?",
  "webhook_url": "https://example.com/webhook",
  "template": "modern",
  "bubble_icon": "message-circle",
  "bubble_position": "bottom-right",
  "bubble_size": "medium",
  "auto_open": false,
  "user_message_color": "#007bff",
  "input_placeholder": "Ask me anything...",
  "greeting_text": "Hi! Need help?",
  "show_branding": true,
  "bubble_icon_image": "<string>",
  "input_bg_color": "#f0f0f0",
  "persistent_buttons": [
    {
      "label": "Schedule Call",
      "icon": "phone",
      "action_type": "url",
      "action_value": "https://calendly.com/demo"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cleartalk.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Chatbot ID

Response

200 - application/json

Returns the chatbot

​
chatbotName
string
required

Name of the chatbot

​
chatbot_title
string
required

Title of the chatbot

​
header_color
string
required

Header color in hex format

Example:

"#000000"

​
background_color
string
required

Background color in hex format

Example:

"#FFFFFF"

​
pathway_id
string
required

Pathway ID for the chatbot

​
text_color
string

Text color in hex format

Example:

"#000000"

​
welcome_message
string

Welcome message shown when chat starts

Example:

"Hi! How can I help you today?"

​
webhook_url
string

Webhook URL to receive extracted variables when a conversation completes

Example:

"https://example.com/webhook"

​
template
enum<string>

UI template for the chatbot widget

Available options:
classic,
modern,
glassmorphism
Example:

"modern"

​
bubble_icon
enum<string>

Icon for the chat bubble

Available options:
message-circle,
sparkles,
bot,
headphones,
help-circle,
heart
Example:

"message-circle"

​
bubble_position
enum<string>

Position of the chat bubble

Available options:
bottom-right,
bottom-left,
bottom-center
Example:

"bottom-right"

​
bubble_size
enum<string>

Size of the chat bubble

Available options:
small,
medium,
large
Example:

"medium"

​
auto_open
boolean

Whether the chat window opens automatically

Example:

false

​
user_message_color
string

Color for user message bubbles (hex)

Example:

"#007bff"

​
input_placeholder
string

Placeholder text for the message input

Example:

"Ask me anything..."

​
greeting_text
string

Greeting text shown as a tooltip near the chat bubble

Example:

"Hi! Need help?"

​
show_branding
boolean

Show "Powered by ClearTalk" branding in chat footer

Example:

true

​
bubble_icon_image
string

Custom bubble icon image path (uploaded file)

​
input_bg_color
string

Input text box background color (hex)

Example:

"#f0f0f0"

​
persistent_buttons
string[]

Persistent action buttons shown at bottom of chat widget (max 4)

Example:
[
  {
    "label": "Schedule Call",
    "icon": "phone",
    "action_type": "url",
    "action_value": "https://calendly.com/demo"
  }
]