Chatbot Settings

Chatbot Settings

Retrieve and update your AI Agent’s full configuration, including personality, conversation style, and system prompt.

Corresponds to Identity > Profile and Identity > Conversation Style in the Dashboard.

Get Chatbot Settings

Scope: read_all

GET https://app.quickchat.ai/v1/api/chatbot_settings

Shell

curl https://app.quickchat.ai/v1/api/chatbot_settings \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/chatbot_settings",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "personality": 0,
  "profession": "helpful_assistant",
  "creativity_level": 1,
  "greeting": "<p>Hello! How can I help you today?</p>",
  "greeting2": "",
  "header": "Support Assistant",
  "header2": "",
  "language_chosen": "en",
  "reply_length": 1,
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"]
}

Field	Description
one_word_description string	AI Agent name. Dashboard: Identity > Profile > AI Agent Name (max 200 chars)
short_description string	System prompt / AI Agent description. Dashboard: Identity > Profile > AI Agent Description (max 2000 chars)
ai_commands array of strings	Behavioral guidelines for the AI. Dashboard: Identity > Conversation Style > AI Guidelines (max 500 chars per item)
personality integer (0–13)	AI personality preset. Dashboard: Identity > Conversation Style > Personality. See table below
profession string	AI profession/role. Dashboard: Identity > Conversation Style > Profession (max 200 chars). See table below
creativity_level integer (0–2)	Dashboard: Identity > Conversation Style > Creativity. 0 = Deterministic, 1 = Balanced, 2 = Creative
reply_length integer (0–2)	Dashboard: Identity > Conversation Style > Reply Length. 0 = Short, 1 = Medium, 2 = Long
greeting string	Primary greeting message (HTML). Dashboard: Identity > Profile > Greeting messages (max 1000 chars)
greeting2 string	Secondary greeting message (HTML). Dashboard: Identity > Profile > Greeting messages
header string	Chat header text. Dashboard: Identity > Profile > Chat header text
header2 string	Secondary header text. Dashboard: Identity > Profile > Chat header text
language_chosen string	Comma-separated language codes (e.g. "en,es,de"). Dashboard: Identity > Profile > Languages

Personality values:

Value	Label	Description
0	Classic	Well-rounded, balanced between professionalism and approachability (default)
1	Humorous	Witty tone with puns and jokes for entertaining interactions
2	Formal	Formal and serious, concise factual information for business settings
3	Friendly	Casual conversations with a personal, approachable touch
4	Sassy	Confident and playful with humor
5	Intelligent	Detailed, accurate information for comprehensive understanding
6	Empathetic	Caring, compassionate interactions showing concern for feelings
7	Bold	Strong opinions and recommendations delivered with confidence
9	Excited	Lively and energetic engagement
10	Mysterious	Cryptic, intriguing responses for a unique experience
11	Inspiring	Promotes positive thinking and goal-reaching in a coach-like fashion
12	Adventurous	Encourages leaving comfort zones and exploring new opportunities
13	Elegant	Sophisticated experience for unique and exquisite brands

Profession values:

Value	Dashboard Label	Description
helpful_assistant	Helpful Assistant	Versatile, multi-purpose. Recommended for most use cases
customer_support_representative	Support Agent	Empathetic, provides step-by-step solutions and troubleshooting
shopping_assistant	Shopping Assistant	Proactively offers product recommendations with links
field_expert	Field Expert	Professional consultant, asks clarifying questions, provides expert guidance
interviewer	Interviewer	Asks questions instead of providing answers. For surveys, interviews, feedback

Note

The one_word_description, short_description, and ai_commands fields are also available through the Knowledge Base Settings endpoint. These fields are shared — updating via either endpoint modifies the same underlying data.

Update Chatbot Settings

Scope: write_all

PATCH https://app.quickchat.ai/v1/api/chatbot_settings

Request Body — All fields are optional. Only include the fields you want to update.

Parameter	Description
personality integer (0–13)	AI personality preset
profession string	AI profession/role (max 200 chars)
creativity_level integer (0–2)	0 = Deterministic, 1 = Balanced, 2 = Creative
greeting string	Primary welcome message (HTML, max 1000 chars)
greeting2 string	Secondary welcome message
header string	Chat header text
header2 string	Secondary header text
language_chosen string	Comma-separated language codes
reply_length integer (0–2)	0 = Short, 1 = Medium, 2 = Long
one_word_description string	AI Agent name (max 200 chars)
short_description string	AI Agent system prompt / description (max 2000 chars)
ai_commands array of strings	AI Guidelines (max 500 chars per item)

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "greeting": "<p>Welcome! Ask me anything.</p>",
  "creativity_level": 2
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/chatbot_settings",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "greeting": "<p>Welcome! Ask me anything.</p>",
        "creativity_level": 2,
    },
)
data = response.json()

Response 200 OK — Returns the updated chatbot settings (same schema as Get Chatbot Settings response).

---