v2
latestOpenAPI 3.0.22026-08-07295198367.7 KBKnowledge Base Customizations
Patch Knowledge Base Customization
patch/knowledge-bases/customization/{kb_id}
Path parameters
kb_idstring uuid required
Query parameters
team_idstring uuid
Request body
kb_namestring
base_system_promptstring
initial_messagesstring[]
prompt_suggestionsstring[]
display_namestring
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
object required