Create Chatbot
Create a chatbot.
Authorizations
Body
The chatbot's name.
An array of resource ids that the chatbot can use.
The model the chatbot uses. Values can be 'gpt-4-turbo-preview' | 'gpt-4' | 'gpt-4o-mini'.
The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.
The chatbot's welcome message. Displayed when the chatbot is first opened.
The HEX background color of the chatbot's messages. Will default to #E0E5EF.
The HEX background color of the user's messages. Will default to #000000.
The HEX color of the chatbot's accent color. Will default to #000000.
The HEX color of the chatbot's background color behind the messages of the selected conversation. Will default to #FFFFFF.
The HEX color of the chatbot's background color behind the conversation menu. Will default to #F2F2F2.
Whether or not the chatbot should use emojis. Defaults to false.
The personnality type of the chatbot. Values can be 'ASSISTANT' | 'COACH' | 'ADVISOR' | 'EXPERT' | 'CUSTOM'.
The tone the chatbot uses. Values can be 'HUMOROUS' | 'FRIENDLY' | 'FORMAL' | 'CUSTOM'.
The custom system prompt the chatbot uses. Defined only if personalityType and toneType are set to '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.
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 website integration configuration of the chatbot. Defined if the chatbot is set to be integrated on one or more websites.
Response
The chatbot's id.
The chatbot's name.
The chatbot's welcome message. Displayed when the chatbot is first opened.
The created date of the chatbot. Unix timestamp in milliseconds.
The user id of the creator.
The organisation id of the chatbot.
An array of resource ids that the chatbot can use.
The HEX background color of the chatbot's messages.
The HEX background color of the user's messages.
The HEX color of the chatbot's accent color.
The HEX color of the chatbot's background color behind the messages of the selected conversation.
The HEX color of the chatbot's background color behind the conversation menu.
Whether or not the chatbot should use emojis.
The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-4-turbo-preview' | 'gpt-4' | 'gpt-4o-mini'.
The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.
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.