Chatbot Settings

Chatbot Settings

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

Behavior settings are under Identity > AI Persona in the Dashboard. Visitor-facing text is under Channels > Your Website > Text Content. The field table below gives the exact location for each setting.

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 > AI Persona > Name. The API accepts up to 200 characters; the in-app field limits it to 40.
short_description string	The Main Prompt (system prompt). Dashboard: Identity > AI Persona > Main Prompt. The API accepts up to 25,000 characters on every plan; the in-app editor limits it to your plan’s ceiling, which starts at 15,000.
ai_commands array of strings	Behavioral guidelines for the AI, one per array item. Dashboard: Identity > AI Persona > Guidelines. Up to 250 items, 5,000 characters per item and 10,000 characters across all items.
personality integer (0–13)	AI personality preset. Dashboard: Identity > AI Persona > Personality. See table below
profession string	AI profession/role. Dashboard: Identity > AI Persona > Profession (max 200 chars). See table below
creativity_level integer (0–2)	Dashboard: Identity > AI Persona > Creativity. 0 = Low, 1 = Normal, 2 = High
reply_length integer (0–2)	Dashboard: Identity > AI Persona > Reply Length. 0 = Short, 1 = Normal, 2 = Longer
greeting string	Primary greeting message (HTML). Dashboard: Channels > Your Website > Text Content > Welcome message (max 1000 chars). This is the same field as welcome_message in Widget Configuration.
greeting2 string	Secondary greeting message (HTML). Available through the API; there is no editor field for it in the Dashboard.
header string	Chat header text. Dashboard: Channels > Your Website > Text Content > Header text (max 200 chars)
header2 string	Secondary header text (max 200 chars). Available through the API as header2, or subtitle in Widget Configuration; there is no editor field for it in the Dashboard.
language_chosen string	Comma-separated language codes (e.g. "en,es,de"). Dashboard: Identity > AI Persona > Languages (max 200 chars total; codes past the 30-language limit are dropped)

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 = Low, 1 = Normal, 2 = High
greeting string	Primary welcome message (HTML, max 1000 chars)
greeting2 string	Secondary welcome message
header string	Chat header text (max 200 chars)
header2 string	Secondary header text (max 200 chars)
language_chosen string	Comma-separated language codes (max 200 chars total; codes past the 30-language limit are dropped)
reply_length integer (0–2)	0 = Short, 1 = Normal, 2 = Longer
one_word_description string	AI Agent name. API max 200 characters; the in-app field limits it to 40.
short_description string	AI Main Prompt (system prompt). The API accepts up to 25,000 characters on every plan; the in-app editor limits it to your plan’s ceiling, which starts at 15,000. An oversized value returns 422.
ai_commands array of strings	AI Guidelines, one per array item. Up to 250 items, 5,000 characters per item and 10,000 characters across all items. An oversized value returns 422.

How guidelines are stored

Each array item is one guideline, saved exactly as you send it. Punctuation, semicolons included, is preserved. This endpoint used to strip ; out of your text before saving, so if you removed or substituted semicolons to work around that, you can stop.

Omit ai_commands, or send null, to leave the guidelines untouched. Send [] to clear them.

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

---