POST
/
v1
/
chatbot
Create Chatbot
curl --request POST \
  --url https://api.droxy.ai/v1/chatbot \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "welcomeMessage": "<string>",
  "resourceIds": [
    "<string>"
  ],
  "chatbotMessageColor": "<string>",
  "userMessageColor": "<string>",
  "conversationBackgroundColor": "<string>",
  "secondaryBackgroundColor": "<string>",
  "gradientColors": [
    "<string>"
  ],
  "showBadge": true,
  "enabledEmoji": true,
  "personalityType": "<string>",
  "toneType": "<string>",
  "customSystemPrompt": "<string>",
  "model": "<string>",
  "restrictAnswersToResourcesContentResponse": "<string>",
  "accessLevel": "<string>",
  "tags": [
    "<string>"
  ],
  "password": "<string>",
  "websiteIntegration": {
    "allowedDomains": [
      "<string>"
    ],
    "bubbleAlignment": "<string>",
    "bubblePopupMessages": [
      "<string>"
    ],
    "welcomeHeaderTitle": "<string>",
    "welcomeHeaderSubtitle": "<string>"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "welcomeMessage": "<string>",
  "createdAt": 123,
  "creator": "<string>",
  "organisation": "<string>",
  "resources": [
    "<string>"
  ],
  "chatbotMessageColor": "<string>",
  "userMessageColor": "<string>",
  "conversationBackgroundColor": "<string>",
  "secondaryBackgroundColor": "<string>",
  "gradientColors": [
    "<string>"
  ],
  "showBadge": true,
  "enabledEmoji": true,
  "customSystemPrompt": "<string>",
  "model": "<string>",
  "restrictAnswersToResourcesContentResponse": "<string>",
  "accessLevel": "<string>",
  "tags": [
    "<string>"
  ],
  "websiteIntegration": {
    "allowedDomains": [
      "<string>"
    ],
    "bubbleAlignment": "<string>",
    "bubblePopupMessages": [
      "<string>"
    ],
    "welcomeHeaderTitle": "<string>",
    "welcomeHeaderSubtitle": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

The chatbot's name.

​
resourceIds
string[]
required

An array of resource ids that the chatbot can use.

​
showBadge
boolean
required

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

​
model
string
required

The model the chatbot uses. Values can be 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4o-realtime-preview-2024-12-17' | 'gpt-4o-mini-realtime-preview-2024-12-17' | 'claude-3-7-sonnet' | 'claude-3-5-sonnet' | 'claude-3-5-haiku' | 'gemini-flash-2.5-preview' | 'gemini-flash-2.0' | 'gemini-pro-1.5' | 'gemini-flash-1.5'.

​
accessLevel
string
required

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

​
welcomeMessage
string

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

​
chatbotMessageColor
string

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

​
userMessageColor
string

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

​
conversationBackgroundColor
string

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

​
secondaryBackgroundColor
string

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

​
gradientColors
string[]

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

​
enabledEmoji
boolean

Whether or not the chatbot should use emojis. Defaults to false.

​
personalityType
string

The personnality type of the chatbot. Values can be 'ASSISTANT' | 'COACH' | 'ADVISOR' | 'EXPERT' | 'CUSTOM'.

​
toneType
string

The tone the chatbot uses. Values can be 'HUMOROUS' | 'FRIENDLY' | 'FORMAL' | 'CUSTOM'.

​
customSystemPrompt
string

The custom system prompt the chatbot uses. Defined only if personalityType and toneType are set to 'CUSTOM'.

​
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.

​
tags
string[]

Tags to assign.

​
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.

​
websiteIntegration
object

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

Response

Created

​
id
string
required

The chatbot's id.

​
name
string
required

The chatbot's name.

​
welcomeMessage
string
required

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

​
createdAt
number
required

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

​
creator
string
required
deprecated

The user id of the creator.

​
organisation
string
required

The organisation id of the chatbot.

​
resources
string[]
required

An array of resource ids that the chatbot can use.

​
chatbotMessageColor
string
required

The HEX background color of the chatbot's messages.

​
userMessageColor
string
required

The HEX background color of the user's messages.

​
conversationBackgroundColor
string
required

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

​
secondaryBackgroundColor
string
required

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

​
gradientColors
string[]
required

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

​
showBadge
boolean
required

Whether or not the chatbot should show the badge.

​
enabledEmoji
boolean
required

Whether or not the chatbot should use emojis.

​
model
string
required

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

​
accessLevel
string
required

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

​
tags
string[]
required

Tags assigned.

​
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.