GET
/
v1
/
chatbot
/
{id}
curl --request GET \
  --url https://api.droxy.ai/v1/chatbot/{id} \
  --header 'x-api-key: <api-key>'
{
  "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

Path Parameters

​
id
string
required

The chatbot's id.

Response

200
application/json
OK
​
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

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.