API Reference

Create Chatbot

post
https://api.droxy.ai/v1/chatbot

Create a chatbot.

Body Params
string
required

The chatbot's name.

string

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

resourceIds
array of strings
required

An array of resource ids that the chatbot can use.

resourceIds*
string

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

string

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

string

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

string

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

gradientColors
array of strings

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

gradientColors
boolean
required

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

boolean

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

string

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

string

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

string

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

string
required

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

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.

string
required

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

tags
array of strings

Tags to assign.

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

Responses

Updated over 2 years ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago