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>",
"resourceIds": [
"<string>"
],
"showBadge": true,
"model": "<string>",
"accessLevel": "<string>",
"welcomeMessage": "<string>",
"chatbotMessageColor": "<string>",
"userMessageColor": "<string>",
"conversationBackgroundColor": "<string>",
"secondaryBackgroundColor": "<string>",
"gradientColors": [
"<string>"
],
"enabledEmoji": true,
"personalityType": "<string>",
"toneType": "<string>",
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"tags": [
"<string>"
],
"password": "<string>",
"websiteIntegration": {
"allowedDomains": [
"<string>"
],
"bubbleAlignment": "<string>",
"bubblePopupMessages": [
"<string>"
],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
resourceIds: ['<string>'],
showBadge: true,
model: '<string>',
accessLevel: '<string>',
welcomeMessage: '<string>',
chatbotMessageColor: '<string>',
userMessageColor: '<string>',
conversationBackgroundColor: '<string>',
secondaryBackgroundColor: '<string>',
gradientColors: ['<string>'],
enabledEmoji: true,
personalityType: '<string>',
toneType: '<string>',
customSystemPrompt: '<string>',
restrictAnswersToResourcesContentResponse: '<string>',
tags: ['<string>'],
password: '<string>',
websiteIntegration: {
allowedDomains: ['<string>'],
bubbleAlignment: '<string>',
bubblePopupMessages: ['<string>'],
welcomeHeaderTitle: '<string>',
welcomeHeaderSubtitle: '<string>'
}
})
};
fetch('https://api.droxy.ai/v1/chatbot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.droxy.ai/v1/chatbot"
payload = {
"name": "<string>",
"resourceIds": ["<string>"],
"showBadge": True,
"model": "<string>",
"accessLevel": "<string>",
"welcomeMessage": "<string>",
"chatbotMessageColor": "<string>",
"userMessageColor": "<string>",
"conversationBackgroundColor": "<string>",
"secondaryBackgroundColor": "<string>",
"gradientColors": ["<string>"],
"enabledEmoji": True,
"personalityType": "<string>",
"toneType": "<string>",
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"tags": ["<string>"],
"password": "<string>",
"websiteIntegration": {
"allowedDomains": ["<string>"],
"bubbleAlignment": "<string>",
"bubblePopupMessages": ["<string>"],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.droxy.ai/v1/chatbot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'resourceIds' => [
'<string>'
],
'showBadge' => true,
'model' => '<string>',
'accessLevel' => '<string>',
'welcomeMessage' => '<string>',
'chatbotMessageColor' => '<string>',
'userMessageColor' => '<string>',
'conversationBackgroundColor' => '<string>',
'secondaryBackgroundColor' => '<string>',
'gradientColors' => [
'<string>'
],
'enabledEmoji' => true,
'personalityType' => '<string>',
'toneType' => '<string>',
'customSystemPrompt' => '<string>',
'restrictAnswersToResourcesContentResponse' => '<string>',
'tags' => [
'<string>'
],
'password' => '<string>',
'websiteIntegration' => [
'allowedDomains' => [
'<string>'
],
'bubbleAlignment' => '<string>',
'bubblePopupMessages' => [
'<string>'
],
'welcomeHeaderTitle' => '<string>',
'welcomeHeaderSubtitle' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.droxy.ai/v1/chatbot")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"showBadge\": true,\n \"model\": \"<string>\",\n \"accessLevel\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"chatbotMessageColor\": \"<string>\",\n \"userMessageColor\": \"<string>\",\n \"conversationBackgroundColor\": \"<string>\",\n \"secondaryBackgroundColor\": \"<string>\",\n \"gradientColors\": [\n \"<string>\"\n ],\n \"enabledEmoji\": true,\n \"personalityType\": \"<string>\",\n \"toneType\": \"<string>\",\n \"customSystemPrompt\": \"<string>\",\n \"restrictAnswersToResourcesContentResponse\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"websiteIntegration\": {\n \"allowedDomains\": [\n \"<string>\"\n ],\n \"bubbleAlignment\": \"<string>\",\n \"bubblePopupMessages\": [\n \"<string>\"\n ],\n \"welcomeHeaderTitle\": \"<string>\",\n \"welcomeHeaderSubtitle\": \"<string>\"\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.droxy.ai/v1/chatbot"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"showBadge\": true,\n \"model\": \"<string>\",\n \"accessLevel\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"chatbotMessageColor\": \"<string>\",\n \"userMessageColor\": \"<string>\",\n \"conversationBackgroundColor\": \"<string>\",\n \"secondaryBackgroundColor\": \"<string>\",\n \"gradientColors\": [\n \"<string>\"\n ],\n \"enabledEmoji\": true,\n \"personalityType\": \"<string>\",\n \"toneType\": \"<string>\",\n \"customSystemPrompt\": \"<string>\",\n \"restrictAnswersToResourcesContentResponse\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"websiteIntegration\": {\n \"allowedDomains\": [\n \"<string>\"\n ],\n \"bubbleAlignment\": \"<string>\",\n \"bubblePopupMessages\": [\n \"<string>\"\n ],\n \"welcomeHeaderTitle\": \"<string>\",\n \"welcomeHeaderSubtitle\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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,
"model": "<string>",
"accessLevel": "<string>",
"tags": [
"<string>"
],
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"websiteIntegration": {
"allowedDomains": [
"<string>"
],
"bubbleAlignment": "<string>",
"bubblePopupMessages": [
"<string>"
],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}Chatbot
Create Chatbot
Create a chatbot.
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>",
"resourceIds": [
"<string>"
],
"showBadge": true,
"model": "<string>",
"accessLevel": "<string>",
"welcomeMessage": "<string>",
"chatbotMessageColor": "<string>",
"userMessageColor": "<string>",
"conversationBackgroundColor": "<string>",
"secondaryBackgroundColor": "<string>",
"gradientColors": [
"<string>"
],
"enabledEmoji": true,
"personalityType": "<string>",
"toneType": "<string>",
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"tags": [
"<string>"
],
"password": "<string>",
"websiteIntegration": {
"allowedDomains": [
"<string>"
],
"bubbleAlignment": "<string>",
"bubblePopupMessages": [
"<string>"
],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
resourceIds: ['<string>'],
showBadge: true,
model: '<string>',
accessLevel: '<string>',
welcomeMessage: '<string>',
chatbotMessageColor: '<string>',
userMessageColor: '<string>',
conversationBackgroundColor: '<string>',
secondaryBackgroundColor: '<string>',
gradientColors: ['<string>'],
enabledEmoji: true,
personalityType: '<string>',
toneType: '<string>',
customSystemPrompt: '<string>',
restrictAnswersToResourcesContentResponse: '<string>',
tags: ['<string>'],
password: '<string>',
websiteIntegration: {
allowedDomains: ['<string>'],
bubbleAlignment: '<string>',
bubblePopupMessages: ['<string>'],
welcomeHeaderTitle: '<string>',
welcomeHeaderSubtitle: '<string>'
}
})
};
fetch('https://api.droxy.ai/v1/chatbot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.droxy.ai/v1/chatbot"
payload = {
"name": "<string>",
"resourceIds": ["<string>"],
"showBadge": True,
"model": "<string>",
"accessLevel": "<string>",
"welcomeMessage": "<string>",
"chatbotMessageColor": "<string>",
"userMessageColor": "<string>",
"conversationBackgroundColor": "<string>",
"secondaryBackgroundColor": "<string>",
"gradientColors": ["<string>"],
"enabledEmoji": True,
"personalityType": "<string>",
"toneType": "<string>",
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"tags": ["<string>"],
"password": "<string>",
"websiteIntegration": {
"allowedDomains": ["<string>"],
"bubbleAlignment": "<string>",
"bubblePopupMessages": ["<string>"],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.droxy.ai/v1/chatbot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'resourceIds' => [
'<string>'
],
'showBadge' => true,
'model' => '<string>',
'accessLevel' => '<string>',
'welcomeMessage' => '<string>',
'chatbotMessageColor' => '<string>',
'userMessageColor' => '<string>',
'conversationBackgroundColor' => '<string>',
'secondaryBackgroundColor' => '<string>',
'gradientColors' => [
'<string>'
],
'enabledEmoji' => true,
'personalityType' => '<string>',
'toneType' => '<string>',
'customSystemPrompt' => '<string>',
'restrictAnswersToResourcesContentResponse' => '<string>',
'tags' => [
'<string>'
],
'password' => '<string>',
'websiteIntegration' => [
'allowedDomains' => [
'<string>'
],
'bubbleAlignment' => '<string>',
'bubblePopupMessages' => [
'<string>'
],
'welcomeHeaderTitle' => '<string>',
'welcomeHeaderSubtitle' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.droxy.ai/v1/chatbot")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"showBadge\": true,\n \"model\": \"<string>\",\n \"accessLevel\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"chatbotMessageColor\": \"<string>\",\n \"userMessageColor\": \"<string>\",\n \"conversationBackgroundColor\": \"<string>\",\n \"secondaryBackgroundColor\": \"<string>\",\n \"gradientColors\": [\n \"<string>\"\n ],\n \"enabledEmoji\": true,\n \"personalityType\": \"<string>\",\n \"toneType\": \"<string>\",\n \"customSystemPrompt\": \"<string>\",\n \"restrictAnswersToResourcesContentResponse\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"websiteIntegration\": {\n \"allowedDomains\": [\n \"<string>\"\n ],\n \"bubbleAlignment\": \"<string>\",\n \"bubblePopupMessages\": [\n \"<string>\"\n ],\n \"welcomeHeaderTitle\": \"<string>\",\n \"welcomeHeaderSubtitle\": \"<string>\"\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.droxy.ai/v1/chatbot"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"resourceIds\": [\n \"<string>\"\n ],\n \"showBadge\": true,\n \"model\": \"<string>\",\n \"accessLevel\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"chatbotMessageColor\": \"<string>\",\n \"userMessageColor\": \"<string>\",\n \"conversationBackgroundColor\": \"<string>\",\n \"secondaryBackgroundColor\": \"<string>\",\n \"gradientColors\": [\n \"<string>\"\n ],\n \"enabledEmoji\": true,\n \"personalityType\": \"<string>\",\n \"toneType\": \"<string>\",\n \"customSystemPrompt\": \"<string>\",\n \"restrictAnswersToResourcesContentResponse\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"websiteIntegration\": {\n \"allowedDomains\": [\n \"<string>\"\n ],\n \"bubbleAlignment\": \"<string>\",\n \"bubblePopupMessages\": [\n \"<string>\"\n ],\n \"welcomeHeaderTitle\": \"<string>\",\n \"welcomeHeaderSubtitle\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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,
"model": "<string>",
"accessLevel": "<string>",
"tags": [
"<string>"
],
"customSystemPrompt": "<string>",
"restrictAnswersToResourcesContentResponse": "<string>",
"websiteIntegration": {
"allowedDomains": [
"<string>"
],
"bubbleAlignment": "<string>",
"bubblePopupMessages": [
"<string>"
],
"welcomeHeaderTitle": "<string>",
"welcomeHeaderSubtitle": "<string>"
}
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}{
"statusCode": 123,
"message": [
"<string>"
],
"error": "<string>"
}Authorizations
Body
application/json
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 model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-5-mini' | 'gpt-realtime' | 'gpt-4o-mini-realtime-preview' | 'claude-sonnet-4.6' | 'claude-haiku-4.5' | 'gemini-3-pro' | 'gemini-3-flash'.
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 #F6F7F8.
The HEX background color of the user's messages. Will default to #E0EEFA.
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 secondary background color. Will default to #F6F7F8.
The HEX colors of the chatbot's gradient color. Must be an array of 4 colors.
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.
Tags to assign.
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.
Show child attributes
Show child attributes
Response
Created
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 background color behind the messages of the selected conversation.
The HEX color of the chatbot's secondary background color.
The HEX colors of the chatbot's gradient color. Must be an array of 4 colors.
Whether or not the chatbot should show the badge.
Whether or not the chatbot should use emojis.
The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-5-mini' | 'gpt-realtime' | 'gpt-4o-mini-realtime-preview' | 'claude-sonnet-4.6' | 'claude-haiku-4.5' | 'gemini-3-pro' | 'gemini-3-flash'.
The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.
Tags assigned.
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.
Show child attributes
Show child attributes