Create Chatbot
Create a chatbot.
Authorizations
Body
The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.
The model the chatbot uses. Values can be 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4o-realtime-preview-2024-10-01' | 'claude-3-5-sonnet' | 'claude-3-5-haiku' | 'gemini-pro-1.5' | 'gemini-flash-1.5'.
The chatbot's name.
An array of resource ids that the chatbot can use.
Whether or not the chatbot should show the badge. Will default to false.
The HEX background color of the chatbot's messages. Will default to #F6F7F8.
The HEX color of the chatbot's background color behind the messages of the selected conversation. Will default to #FFFFFF.
The custom system prompt the chatbot uses. Defined only if personalityType and toneType are set to 'CUSTOM'.
Whether or not the chatbot should use emojis. Defaults to false.
The HEX colors of the chatbot's gradient color. Must be an array of 4 colors.
If the chatbot is private, the password to access it. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.
The personnality type of the chatbot. Values can be 'ASSISTANT' | 'COACH' | 'ADVISOR' | 'EXPERT' | 'CUSTOM'.
Answer the chatbot must return if information is not found in the resources. If not set, the chatbot will not be restricted to the knowledge from the resources.
The HEX color of the chatbot's secondary background color. Will default to #F6F7F8.
The tone the chatbot uses. Values can be 'HUMOROUS' | 'FRIENDLY' | 'FORMAL' | 'CUSTOM'.
The HEX background color of the user's messages. Will default to #E0EEFA.
The website integration configuration of the chatbot. Defined if the chatbot is set to be integrated on one or more websites.
The chatbot's welcome message. Displayed when the chatbot is first opened.
Response
The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.
The HEX background color of the chatbot's messages.
The HEX color of the chatbot's background color behind the messages of the selected conversation.
The created date of the chatbot. Unix timestamp in milliseconds.
The user id of the creator.
Whether or not the chatbot should use emojis.
The HEX colors of the chatbot's gradient color. Must be an array of 4 colors.
The chatbot's id.
The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-4-turbo-preview' | 'gpt-4' | 'gpt-4o-mini'.
The chatbot's name.
The organisation id of the chatbot.
An array of resource ids that the chatbot can use.
The HEX color of the chatbot's secondary background color.
Whether or not the chatbot should show the badge.
The HEX background color of the user's messages.
The chatbot's welcome message. Displayed when the chatbot is first opened.
The custom system prompt the chatbot uses. This defines the behavior of the chatbot.
Answer the chatbot must return if information is not found in the resources. If not set, the chatbot will not be restricted to the knowledge from the resources.
The website integration configuration of the chatbot. Defined if the chatbot is set to be integrated on one or more websites.