--- title: "Create Knowledge Base Customization" method: POST path: "/knowledge-bases/customization/" tags: ["Knowledge Base Customizations"] --- # Create Knowledge Base Customization `POST /knowledge-bases/customization/` Endpoint to create knowledge base customization. ## Query parameters - `team_id` string, uuid ## Request body - KnowledgeBaseCustomizationPayload - `kb_id` string, uuid, required - `kb_name` string, required - `base_system_prompt` string - `initial_messages` string[] - `prompt_suggestions` string[] - `display_name` string, required - `integration_mode` 'TEXT' | 'AVATAR' — An enumeration. - `avatar_id` string, uuid - `voice_id` string, 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_color` string - `dante_chat_color` string - `embed_logo_url` string - `embed_page_url` string - `chatbot_profile_pic` string - `prompts_color` string - `custom_url` string - `show_tooltips` boolean - `remove_dante_logo` boolean - `custom_url_favicon` string - `custom_url_title` string - `custom_url_meta` string - `custom_url_meta_image` string - `custom_url_meta_description` string - `font_name` string - `font_size` integer - `dante_font_color` string - `visitor_font_color` string - `chat_background_color` string - `custom_css` string - `hide_microphone_icon` boolean - `hide_play_icon` boolean - `password` string - `public` boolean - `enabled` boolean - `max_number_of_credits` integer - `number_of_messages_per_minutes` integer - `number_of_minutes` integer - `max_messages_in_conversations` integer - `temperature` number - `prompts_font_color` string - `input_background` string - `scrollbar_color` string - `input_placeholder_text` string - `show_prompt_messages` boolean - `is_bubble_opened` boolean - `disclaimer_text` string - `dante_border_color` string - `visitor_border_color` string - `timestamp_color` string - `close_icon_color` string - `data_collection_title` string - `data_collection_fields` KBInputField[] - `input_name` string, required — The name of the input field. - `input_type` string, required — The type of the input field. - `input_label` string, required — The label of the input field. - `input_placeholder` string, required — The placeholder of the input field. - `is_mandatory` boolean, required — Flag indicating whether the input field is mandatory. - `data_collection` boolean - `data_collection_as_nlp` boolean - `data_collection_consent_text` string - `is_data_collection_optional` boolean - `show_data_collection_on_conversation_begin` boolean - `data_collection_rule` string - `intercom_api_key` string - `intercom_company_id` string - `intercom_company_name` string - `intercom_company_tag` string - `disclaimer_text_color` string - `intercom_enabled` boolean - `intercom_connection_state` boolean - `talk_to_live_agent` boolean - `live_agent_email_prompt` string - `live_agent_name_prompt` string - `live_agent_always_active` boolean - `live_agent_list_of_schedules` object[] - `live_agent_user_timezone` string - `show_live_agent_on_conversation_begin` boolean - `show_live_agent_rule` string - `hide_email_button` boolean - `calendly_integration_enabled` boolean - `calendly_url` string - `show_calendly_at_the_start` boolean - `show_calendly_rule` string - `personalities_template` string - `suggested_prompts_appearance` string - `whitelisted_domains` string[] - `finished_steps` string[] - `open_to_internet_knowledge` boolean - `realtime_voice_access` boolean - `custom_url_enabled` boolean - `remove_watermark` boolean - `show_welcome_message_as_tooltip` boolean - `show_email_details` boolean - `show_microphone` boolean - `show_play_button` boolean - `open_chat_by_default` boolean - `brand_color` string - `element_color` string - `surface_color` string - `alert_color` string - `positive_color` string - `negative_color` string - `disclaimer_enabled` boolean - `brand_website` string - `chatbot_icon` string - `calendly_btn_text` string - `suggested_prompts_enabled` boolean ## Response `200` Successful Response - KnowledgeBaseCustomization - `id` string, uuid - `date_created` string, date-time - `date_updated` string, date-time - `user_id` string, uuid — The ID of the user associated with the knowledge base customization. - `kb_id` string, uuid, required — The ID of the knowledge base associated with the customization. - `kb_name` string, required — The name of the knowledge base. - `integration_mode` 'TEXT' | 'AVATAR' — An enumeration. - `base_system_prompt` string — The base system prompt used for the knowledge base. - `initial_messages` string[] — The list of initial messages for the knowledge base. - `prompt_suggestions` string[] — The list of prompt suggestions for the knowledge base. - `display_name` string, required — The display name for the knowledge base. - `visitor_chat_color` string — The color for visitor chat in the knowledge base. - `dante_chat_color` string — The color for Dante chat in the knowledge base. - `chatbot_profile_pic` string — The profile picture URL for the chatbot in the knowledge base. - `embed_logo_url` string — The URL of the logo used for embedding the knowledge base. - `embed_page_url` string — The URL of the page where the knowledge base is embedded. - `prompts_color` string — The color for prompts in the knowledge base. - `custom_url` string — The custom URL for the knowledge base. - `dns_values` object[] — The list of DNS records for the custom url of the knowledge base. - `custom_url_favicon` string - `custom_url_title` string — Page title to be used when sharing with custom url. - `custom_url_meta` string — Page meta to be used when sharing with custom url. - `custom_url_meta_image` string — Page meta image to be used when sharing with custom url. - `custom_url_meta_description` string — Page meta description to be used when sharing with custom url. - `show_tooltips` boolean — Flag indicating whether tooltips should be shown in the knowledge base. - `remove_dante_logo` boolean — Flag indicating whether we remove the dante logo or not. - `font_name` string — Name of the font to be used. - `font_size` integer — Size of the Font to be used. - `dante_font_color` string — Font Color of Dante logo. - `visitor_font_color` string — Color of the font displayed for visitors. - `chat_background_color` string — Background color of the chat. - `custom_css` string - `hide_microphone_icon` boolean — Flag indicating whether we hide microphone icon or not. - `hide_play_icon` boolean — Flag indicating whether we hide play icon or not. - `password` string — Password set for the chatbot in case it is private. - `public` boolean — Flag indicating whether the chatbot for kb is public. - `enabled` boolean — Flag indicating whether the chatbot for this kb is enabled. - `max_number_of_credits` integer — Max number of credits that can be used for this knowledge. - `prompts_font_color` string — Color of the prompts font in the knowledge base. - `input_background` string — Background of the input. - `scrollbar_color` string — Color of the scrollbar for the knowledge base. - `input_placeholder_text` string — Default text specified for the input. - `show_prompt_messages` boolean — Flag indicating whether to show the prompt message. - `is_bubble_opened` boolean — Flag indicating whether Is the bubble opened by default or not. - `disclaimer_text` string — The disclaimer text that should be shown under the query input. - `timestamp_color` string — Color of the message timestamp. - `close_icon_color` string — Color of the close icon on chat bubble. - `data_collection_title` string — The title which is shown with data collection form. - `data_collection_fields` KBInputField[] — The list of fields for the data collection. - `input_name` string, required — The name of the input field. - `input_type` string, required — The type of the input field. - `input_label` string, required — The label of the input field. - `input_placeholder` string, required — The placeholder of the input field. - `is_mandatory` boolean, required — Flag indicating whether the input field is mandatory. - `data_collection` boolean — Flag indicating whether data collection is enabled or not. - `data_collection_as_nlp` boolean — Flag indicating if the data collection shows as nlp form or data collection form - `data_collection_consent_text` string — The text shown on user consent. - `is_data_collection_optional` boolean — Flag indicating whether data collection form is optional or not - `show_data_collection_on_conversation_begin` boolean — Flag indicating whether to show data collection form in the beginning of conversation - `data_collection_rule` string — Rule that sets the condition when to show the data collection form - `number_of_messages_per_minutes` integer — Number of messages set by user that can be sent per minutes specified by user. - `number_of_minutes` integer — Number of minutes set by user that other users can send messages specified in number_of_messages_per_minutes. - `max_messages_in_conversations` integer — Maximum number of messages in a shared conversation of this knowledge base. - `temperature` number — Temperature used by the chatbot - `intercom_api_key` string — The intercom api key for the knowledge base. - `intercom_company_id` string — The intercom company id for the knowledge base. - `intercom_company_name` string — The intercom company name related to this knowledge base. - `intercom_company_tag` string — The intercom company tag for the knowledge base. - `intercom_enabled` boolean — The intercom integration enable switch. - `disclaimer_text_color` string — The color of the disclaimer text. - `visitor_border_color` string — The color of the disclaimer text. - `dante_border_color` string — The color of the disclaimer text. - `intercom_connection_state` boolean — Flag indication whether Intercom Integration Connection has been achieved. - `talk_to_live_agent` boolean — Flag indicating whether we show the Live to Talk Agent button or not. - `live_agent_email_prompt` string — The live agent email prompt. - `live_agent_name_prompt` string — The live agent name prompt. - `live_agent_always_active` boolean — Flag indication whether live agent is always on. - `live_agent_user_timezone` string — The time zone of the live agent user. - `live_agent_list_of_schedules` object[] — Live agent list of schedules. - `show_live_agent_on_conversation_begin` boolean — Flag indicating whether to live agent option in the beginning of conversation - `show_live_agent_rule` string — Rule that sets the condition when to show the live agent button - `hide_email_button` boolean — Flag indicating whether the email button is hidden or not - `calendly_integration_enabled` boolean — Boolean indicating if calendly was integrated or not - `calendly_url` string — Calendly URL provided by the user - `show_calendly_at_the_start` boolean — Boolean indicating if calendly should be shown on conversation start - `show_calendly_rule` string — Rule for deciding whether the calendly should be shown or not - `personalities_template` string — The templates of personality. - `finished_steps` string[] — Finished steps - `suggested_prompts_appearance` string — Show suggested prompts - `whitelisted_domains` string[] — Comma-separated list of domains that are allowed to access the knowledge base. - `open_to_internet_knowledge` boolean — Flag indicating whether we want to open to internet. - `realtime_voice_access` boolean — Flag indicating whether realtime voice access is enabled. - `custom_url_enabled` boolean — Flag indicating whether custom URL is enabled. - `remove_watermark` boolean — Flag indicating whether to remove the watermark. - `show_welcome_message_as_tooltip` boolean — Flag indicating whether to show welcome message as tooltip. - `show_email_details` boolean — Flag indicating whether to show email details. - `show_microphone` boolean — Flag indicating whether to show microphone. - `show_play_button` boolean — Flag indicating whether to show play button. - `open_chat_by_default` boolean — Flag indicating whether to open chat by default. - `brand_color` string — The color of the brand. - `element_color` string — The color of the element. - `surface_color` string — The color of the surface. - `alert_color` string — The color of the alert. - `positive_color` string — The color of the positive. - `negative_color` string — The color of the negative. - `disclaimer_enabled` boolean — Flag indicating whether disclaimer is enabled. - `brand_website` string, required — The website of the brand. - `chatbot_icon` string, required — The icon of the chatbot. - `calendly_btn_text` string, required — The text of the calendly button. - `suggested_prompts_enabled` boolean — Flag indicating whether suggested prompts are enabled. - `autorefresh_enabled` boolean — Flag indicating whether autorefresh is enabled. - `home_tab_enabled` boolean — Flag indicating whether home tab is enabled. - `avatar_enabled` boolean — Flag indicating whether avatar is enabled. ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/dante-ai/apis/dante-ai-api.md) · [All operations](https://skmtc.net/dante-ai/apis/dante-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dante-ai/dante-ai-api/versions/38b6c9a4246d/schema)