PUT
/
v1
/
chatbot
/
{id}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The chatbot's id.

Body

application/json
accessLevel
string

The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.

chatbotMessageColor
string

The HEX background color of the chatbot's messages. Will default to #F6F7F8.

conversationBackgroundColor
string

The HEX color of the chatbot's background color behind the messages of the selected conversation. Will default to #FFFFFF.

customSystemPrompt
string

The custom system prompt the chatbot uses. This defines the behavior of the chatbot.

enabledEmoji
boolean

Whether or not the chatbot should use emojis.

gradientColors
string

The HEX color of the chatbot's gradient color. Set to empty string to remove the gradient.

model
string

The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-4-turbo-preview' |'gpt-4'.

name
string

The chatbot's name.

password
string

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.

resourceIds
string[]

An array of resource ids that the chatbot can use.

restrictAnswersToResourcesContentResponse
string

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.

secondaryBackgroundColor
string

The HEX color of the chatbot's secondary background color. Will default to #F6F7F8.

showBadge
boolean

Whether or not the chatbot should show the badge. Will default to false.

userMessageColor
string

The HEX background color of the user's messages. Will default to #E0EEFA.

welcomeMessage
string

The chatbot's welcome message. Displayed when the chatbot is first opened.

Response

200 - application/json
accessLevel
string
required

The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.

chatbotMessageColor
string
required

The HEX background color of the chatbot's messages.

conversationBackgroundColor
string
required

The HEX color of the chatbot's background color behind the messages of the selected conversation.

createdAt
number
required

The created date of the chatbot. Unix timestamp in milliseconds.

creator
string
required

The user id of the creator.

enabledEmoji
boolean
required

Whether or not the chatbot should use emojis.

gradientColors
string[]
required

The HEX colors of the chatbot's gradient color. Must be an array of 4 colors.

id
string
required

The chatbot's id.

model
string
required

The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-4-turbo-preview' | 'gpt-4' | 'gpt-4o-mini'.

name
string
required

The chatbot's name.

organisation
string
required

The organisation id of the chatbot.

resources
string[]
required

An array of resource ids that the chatbot can use.

secondaryBackgroundColor
string
required

The HEX color of the chatbot's secondary background color.

showBadge
boolean
required

Whether or not the chatbot should show the badge.

userMessageColor
string
required

The HEX background color of the user's messages.

welcomeMessage
string
required

The chatbot's welcome message. Displayed when the chatbot is first opened.

customSystemPrompt
string

The custom system prompt the chatbot uses. This defines the behavior of the chatbot.

restrictAnswersToResourcesContentResponse
string

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.

websiteIntegration
object

The website integration configuration of the chatbot. Defined if the chatbot is set to be integrated on one or more websites.