Sign in

v2

latestOpenAPI 3.0.22026-08-07295198367.7 KB
Knowledge Base Customizations

Create Knowledge Base Customization

Endpoint to create knowledge base customization.

post/knowledge-bases/customization/

Query parameters

team_idstring uuid

Request body

kb_idstring uuid required
kb_namestring required
base_system_promptstring
initial_messagesstring[]
prompt_suggestionsstring[]
display_namestring required
integration_mode'TEXT' | 'AVATAR'

An enumeration.

avatar_idstring uuid
voice_idstring uuid
speaking_style'advertisement_upbeat' | 'affectionate' | 'angry' | 'assistant' | 'calm' | 'chat' | 'cheerful' | 'customerservice' | 'depressed' | 'disgruntled' | 'documentary-narration' | 'embarassed' | 'empathetic' | 'envious' | 'excited' | 'fearful' | 'friendly' | 'gentle' | 'hopeful' | 'lyrical' | 'narration-professional' | 'narration-relaxed' | 'newscast' | 'newscast-casual' | 'newscast-formal' | 'poetry-reading' | 'sad' | 'serious' | 'shouting' | 'sports_commentary' | 'sports_commentary_excited' | 'whispering' | 'terrified' | 'unfriendly'

An enumeration.

visitor_chat_colorstring
dante_chat_colorstring
embed_logo_urlstring
embed_page_urlstring
chatbot_profile_picstring
prompts_colorstring
custom_urlstring
show_tooltipsboolean
remove_dante_logoboolean
custom_url_faviconstring
custom_url_titlestring
custom_url_metastring
custom_url_meta_imagestring
custom_url_meta_descriptionstring
font_namestring
font_sizeinteger
dante_font_colorstring
visitor_font_colorstring
chat_background_colorstring
custom_cssstring
hide_microphone_iconboolean
hide_play_iconboolean
passwordstring
publicboolean
enabledboolean
max_number_of_creditsinteger
number_of_messages_per_minutesinteger
number_of_minutesinteger
max_messages_in_conversationsinteger
temperaturenumber
prompts_font_colorstring
input_backgroundstring
scrollbar_colorstring
input_placeholder_textstring
show_prompt_messagesboolean
is_bubble_openedboolean
disclaimer_textstring
dante_border_colorstring
visitor_border_colorstring
timestamp_colorstring
close_icon_colorstring
data_collection_titlestring
data_collectionboolean
data_collection_as_nlpboolean
data_collection_consent_textstring
is_data_collection_optionalboolean
show_data_collection_on_conversation_beginboolean
data_collection_rulestring
intercom_api_keystring
intercom_company_idstring
intercom_company_namestring
intercom_company_tagstring
disclaimer_text_colorstring
intercom_enabledboolean
intercom_connection_stateboolean
talk_to_live_agentboolean
live_agent_email_promptstring
live_agent_name_promptstring
live_agent_always_activeboolean
live_agent_list_of_schedulesobject[]
live_agent_user_timezonestring
show_live_agent_on_conversation_beginboolean
show_live_agent_rulestring
hide_email_buttonboolean
calendly_integration_enabledboolean
calendly_urlstring
show_calendly_at_the_startboolean
show_calendly_rulestring
personalities_templatestring
suggested_prompts_appearancestring
whitelisted_domainsstring[]
finished_stepsstring[]
open_to_internet_knowledgeboolean
realtime_voice_accessboolean
custom_url_enabledboolean
remove_watermarkboolean
show_welcome_message_as_tooltipboolean
show_email_detailsboolean
show_microphoneboolean
show_play_buttonboolean
open_chat_by_defaultboolean
brand_colorstring
element_colorstring
surface_colorstring
alert_colorstring
positive_colorstring
negative_colorstring
disclaimer_enabledboolean
brand_websitestring
chatbot_iconstring
calendly_btn_textstring
suggested_prompts_enabledboolean

Response

Successful Response

idstring uuid
date_createdstring date-time
date_updatedstring date-time
user_idstring uuid

The ID of the user associated with the knowledge base customization.

kb_idstring uuid required

The ID of the knowledge base associated with the customization.

kb_namestring required

The name of the knowledge base.

integration_mode'TEXT' | 'AVATAR'

An enumeration.

base_system_promptstring

The base system prompt used for the knowledge base.

initial_messagesstring[]

The list of initial messages for the knowledge base.

prompt_suggestionsstring[]

The list of prompt suggestions for the knowledge base.

display_namestring required

The display name for the knowledge base.

visitor_chat_colorstring

The color for visitor chat in the knowledge base.

dante_chat_colorstring

The color for Dante chat in the knowledge base.

chatbot_profile_picstring

The profile picture URL for the chatbot in the knowledge base.

embed_logo_urlstring

The URL of the logo used for embedding the knowledge base.

embed_page_urlstring

The URL of the page where the knowledge base is embedded.

prompts_colorstring

The color for prompts in the knowledge base.

custom_urlstring

The custom URL for the knowledge base.

dns_valuesobject[]

The list of DNS records for the custom url of the knowledge base.

custom_url_faviconstring
custom_url_titlestring

Page title to be used when sharing with custom url.

custom_url_metastring

Page meta to be used when sharing with custom url.

custom_url_meta_imagestring

Page meta image to be used when sharing with custom url.

custom_url_meta_descriptionstring

Page meta description to be used when sharing with custom url.

show_tooltipsboolean

Flag indicating whether tooltips should be shown in the knowledge base.

remove_dante_logoboolean

Flag indicating whether we remove the dante logo or not.

font_namestring

Name of the font to be used.

font_sizeinteger

Size of the Font to be used.

dante_font_colorstring

Font Color of Dante logo.

visitor_font_colorstring

Color of the font displayed for visitors.

chat_background_colorstring

Background color of the chat.

custom_cssstring
hide_microphone_iconboolean

Flag indicating whether we hide microphone icon or not.

hide_play_iconboolean

Flag indicating whether we hide play icon or not.

passwordstring

Password set for the chatbot in case it is private.

publicboolean

Flag indicating whether the chatbot for kb is public.

enabledboolean

Flag indicating whether the chatbot for this kb is enabled.

max_number_of_creditsinteger

Max number of credits that can be used for this knowledge.

prompts_font_colorstring

Color of the prompts font in the knowledge base.

input_backgroundstring

Background of the input.

scrollbar_colorstring

Color of the scrollbar for the knowledge base.

input_placeholder_textstring

Default text specified for the input.

show_prompt_messagesboolean

Flag indicating whether to show the prompt message.

is_bubble_openedboolean

Flag indicating whether Is the bubble opened by default or not.

disclaimer_textstring

The disclaimer text that should be shown under the query input.

timestamp_colorstring

Color of the message timestamp.

close_icon_colorstring

Color of the close icon on chat bubble.

data_collection_titlestring

The title which is shown with data collection form.

data_collectionboolean

Flag indicating whether data collection is enabled or not.

data_collection_as_nlpboolean

Flag indicating if the data collection shows as nlp form or data collection form

data_collection_consent_textstring

The text shown on user consent.

is_data_collection_optionalboolean

Flag indicating whether data collection form is optional or not

show_data_collection_on_conversation_beginboolean

Flag indicating whether to show data collection form in the beginning of conversation

data_collection_rulestring

Rule that sets the condition when to show the data collection form

number_of_messages_per_minutesinteger

Number of messages set by user that can be sent per minutes specified by user.

number_of_minutesinteger

Number of minutes set by user that other users can send messages specified in number_of_messages_per_minutes.

max_messages_in_conversationsinteger

Maximum number of messages in a shared conversation of this knowledge base.

temperaturenumber

Temperature used by the chatbot

intercom_api_keystring

The intercom api key for the knowledge base.

intercom_company_idstring

The intercom company id for the knowledge base.

intercom_company_namestring

The intercom company name related to this knowledge base.

intercom_company_tagstring

The intercom company tag for the knowledge base.

intercom_enabledboolean

The intercom integration enable switch.

disclaimer_text_colorstring

The color of the disclaimer text.

visitor_border_colorstring

The color of the disclaimer text.

dante_border_colorstring

The color of the disclaimer text.

intercom_connection_stateboolean

Flag indication whether Intercom Integration Connection has been achieved.

talk_to_live_agentboolean

Flag indicating whether we show the Live to Talk Agent button or not.

live_agent_email_promptstring

The live agent email prompt.

live_agent_name_promptstring

The live agent name prompt.

live_agent_always_activeboolean

Flag indication whether live agent is always on.

live_agent_user_timezonestring

The time zone of the live agent user.

live_agent_list_of_schedulesobject[]

Live agent list of schedules.

show_live_agent_on_conversation_beginboolean

Flag indicating whether to live agent option in the beginning of conversation

show_live_agent_rulestring

Rule that sets the condition when to show the live agent button

hide_email_buttonboolean

Flag indicating whether the email button is hidden or not

calendly_integration_enabledboolean

Boolean indicating if calendly was integrated or not

calendly_urlstring

Calendly URL provided by the user

show_calendly_at_the_startboolean

Boolean indicating if calendly should be shown on conversation start

show_calendly_rulestring

Rule for deciding whether the calendly should be shown or not

personalities_templatestring

The templates of personality.

finished_stepsstring[]

Finished steps

suggested_prompts_appearancestring

Show suggested prompts

whitelisted_domainsstring[]

Comma-separated list of domains that are allowed to access the knowledge base.

open_to_internet_knowledgeboolean

Flag indicating whether we want to open to internet.

realtime_voice_accessboolean

Flag indicating whether realtime voice access is enabled.

custom_url_enabledboolean

Flag indicating whether custom URL is enabled.

remove_watermarkboolean

Flag indicating whether to remove the watermark.

show_welcome_message_as_tooltipboolean

Flag indicating whether to show welcome message as tooltip.

show_email_detailsboolean

Flag indicating whether to show email details.

show_microphoneboolean

Flag indicating whether to show microphone.

show_play_buttonboolean

Flag indicating whether to show play button.

open_chat_by_defaultboolean

Flag indicating whether to open chat by default.

brand_colorstring

The color of the brand.

element_colorstring

The color of the element.

surface_colorstring

The color of the surface.

alert_colorstring

The color of the alert.

positive_colorstring

The color of the positive.

negative_colorstring

The color of the negative.

disclaimer_enabledboolean

Flag indicating whether disclaimer is enabled.

brand_websitestring required

The website of the brand.

chatbot_iconstring required

The icon of the chatbot.

calendly_btn_textstring required

The text of the calendly button.

suggested_prompts_enabledboolean

Flag indicating whether suggested prompts are enabled.

autorefresh_enabledboolean

Flag indicating whether autorefresh is enabled.

home_tab_enabledboolean

Flag indicating whether home tab is enabled.

avatar_enabledboolean

Flag indicating whether avatar is enabled.