API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Icons
Chatbot Links
Chatbot Messages
Chatbot Personas
Chatbot Prompts
Chatbot Quick Prompts
Chatbot Settings
Chatbot Threads
Fetch All Chatbots
Fetch all the chatbots
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Delimeter to identify multiple values in other parameters
Array of keys to be searched in metadata (separated by delimeter)
Array of values to be searched against above metadata keys (separated by delimeter)
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Delimeter to identify multiple values in other parameters
Array of keys to be searched in metadata (separated by delimeter)
Array of values to be searched against above metadata keys (separated by delimeter)
Response
Success Response
Indicates whether this is success response or error response
Overall message regarding the operation performed
Data returned from the server
List of chatbots
Id of the chatbot
Title of the chatbot
Description of the chatbot
Id of the user that created this chatbot
Email of the user that created this chatbot
Custom content of the chatbot
Quick prompts of the chatbot
Id of the quick-prompt
Title of the quick-prompt. This is the text that is shown as button in the chatbot.
Link of the quick prompt. If this link is not null, then when you click on the quick prompt in the chatbot, this link will be opened instead of sending a message to the chatbot.
Description of the quick-prompt. This is the message that will be sent to the chatbot when you click on the quick-prompt inside the chatbot.
List of prompts set by the user
Id of the prompt
Title of the prompt
Short description of the prompt
Actual instructions of the prompt. These will be sent to Open AI.
Decides creativity level of the chatbot response. 0 is more focused and 1 is more creative/random.
0 < x < 1Must be a multiple of 0.01Follow-up prompts of the chatbot
Id of the follow-up prompt.
Title of the follow-up-prompt. This is the text that is shown as button in the chatbot.
Link of the follow-up prompt. If this link is not null, then when you click on the follow-up prompt in the chatbot, this link will be opened instead of sending a message to the chatbot.
Description of the follow-up-prompt. This is the message that will be sent to the chatbot when you click on the follow-up-prompt inside the chatbot.
Indicates whether the follow-up prompt is escalation prompt or not.
Settings of the chatbot
This tooltip will be shown on the top of chatbot icon. If not set, welcome message will be shown as tooltip
The first message that the users will see in the chatbot
Placeholder text that users see before they type their question in the chat
Primary color of the chatbot
Primary text color of the chatbot
Indicates whether to display sources or not in the chatbot
Indicates whether to hide tooltip or not in the chatbot
Indicates whether to hide feedback buttons (for each reply) or not in the chatbot
Indicates whether to display the text in the chatbot right to left or opposite
Text to be shown as the watermark in the chatbot
Option to handle behaviour auto open chat window in desktop
ALWAYS_OPEN_WITH_DELAY, DONT_OPEN Delay after which the chat window will shown in desktop when autoOpenChatWindowInDesktop is set to AUTO_OPEN_WITH_DELAY
Option to handle behaviour auto open chat window in mobile
ALWAYS_OPEN_WITH_DELAY, DONT_OPEN Delay after which the chat window will shown in mobile when autoOpenChatWindowInMobile is set to AUTO_OPEN_WITH_DELAY
Indicates whether the watermark is shown in the chatbot or not
Url of the watermark to be shown in the chatbot
Distance from bottom (in px) where the chatbot icon should be shown
Horizantal distance (in px) where the chatbot icon should be shown
Font size of the text shown in chatbot (in px)
Possible options foe icon size of the chatbot
SMALL, MEDIUM, LARGE, XL, 2XL, 3XL, 4XL, 5XL Possible options for icon position of the chatbot
LEFT, RIGHT Height of the chatbot
Call to Action text
Call to Action Link
Localization settings of the chatbot
Localization option for Learn more option
Localization settings for home screen in the chatbot
Localization settings for messages screen in the chatbot
Localization settings for individual conversations in the chatbot
Localization settings for account screen in the chatbot
Max width of the chatbot
Url reference of the Bot icon
Url reference of the User/person icon
Url reference of the Agent icon
Url reference of the Watermark icon
Url reference of the Chat Buuble icon
Use this to change the tone of your chatbot and also give any additional instructions
Use this to change the instructions you give to your chatbot in the user prompt
Selected promptId that will be used as prompt to generate Open AI response
Option to disable smart followup questions generated by SiteGPT.
Number of smart follow up questions to be shown when enabled.
1 < x < 5Must be a multiple of 1Option to disable email notifications for new lead captures.
Number of history messages to be considered when answering the question
0 < x < 50Must be a multiple of 1Creativity meter of the chatbot. This is valid only when creativity of the chatbot is custom
0 < x < 2Must be a multiple of 0.01Number of relevant chunks to be fetched for answering the question
1 < x < 5Must be a multiple of 1All available GPT models
gpt-3.5-turbo, gpt-4 Options of the creativity for the chatbot
restricted, conservative, creative, custom All messages are sent to this global webhook url if webhook url is not configured at thread level
This is the global webhook token that is sent in header in the calls made to the above webhook url for all messages if token is not configured at thread level
Mode of the chat
AI, AGENT Options whether to collect user details or not
MANDATORY, OPTIONAL, DO_NOT_COLLECT Any extra data you want to add to your chatbot.
Any metadata (key-value pairs) that you can assign to the chatbot. Key should be string and Value could be anything.
Was this page helpful?