Chatbot Settings

Chatbot Settings

Récupérez et mettez à jour la configuration complète de votre AI Agent, y compris la personnalité, le style de conversation et le system prompt.

Correspond à Identity > Profile et Identity > Conversation Style dans le 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	Nom de l’AI Agent. Dashboard : Identity > Profile > AI Agent Name (max 200 caractères)
short_description string	System prompt / description de l’AI Agent. Dashboard : Identity > Profile > AI Agent Description (max 2000 caractères)
ai_commands array of strings	Consignes comportementales pour l’IA. Dashboard : Identity > Conversation Style > AI Guidelines (max 500 caractères par élément, max 5000 caractères au total pour tous les éléments)
personality integer (0–13)	Preset de personnalité de l’IA. Dashboard : Identity > Conversation Style > Personality. Voir le tableau ci-dessous
profession string	Profession/rôle de l’IA. Dashboard : Identity > Conversation Style > Profession (max 200 caractères). Voir le tableau ci-dessous
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	Message d’accueil principal (HTML). Dashboard : Identity > Profile > Greeting messages (max 1000 caractères)
greeting2 string	Message d’accueil secondaire (HTML). Dashboard : Identity > Profile > Greeting messages
header string	Texte de l’en-tête du chat. Dashboard : Identity > Profile > Chat header text (max 200 caractères)
header2 string	Texte d’en-tête secondaire. Dashboard : Identity > Profile > Chat header text (max 200 caractères)
language_chosen string	Codes de langue séparés par des virgules (p. ex. "en,es,de"). Dashboard : Identity > Profile > Languages (max 10 caractères au total)

Valeurs de Personality :

Value	Label	Description
0	Classic	Polyvalent, équilibré entre professionnalisme et accessibilité (par défaut)
1	Humorous	Ton spirituel avec jeux de mots et blagues pour des interactions divertissantes
2	Formal	Formel et sérieux, informations factuelles concises pour les contextes professionnels
3	Friendly	Conversations décontractées avec une touche personnelle et accessible
4	Sassy	Sûr de lui et joueur, avec de l’humour
5	Intelligent	Informations détaillées et précises pour une compréhension complète
6	Empathetic	Interactions attentionnées et compatissantes, montrant de l’intérêt pour les ressentis
7	Bold	Opinions et recommandations tranchées exprimées avec assurance
9	Excited	Engagement vif et énergique
10	Mysterious	Réponses énigmatiques et intrigantes pour une expérience unique
11	Inspiring	Encourage la pensée positive et l’atteinte des objectifs, à la manière d’un coach
12	Adventurous	Incite à sortir de sa zone de confort et à explorer de nouvelles opportunités
13	Elegant	Expérience sophistiquée pour les marques uniques et raffinées

Valeurs de Profession :

Value	Dashboard Label	Description
helpful_assistant	Helpful Assistant	Polyvalent, multi-usage. Recommandé pour la plupart des cas d’usage
customer_support_representative	Support Agent	Empathique, fournit des solutions étape par étape et du dépannage
shopping_assistant	Shopping Assistant	Propose proactivement des recommandations de produits avec des liens
field_expert	Field Expert	Consultant professionnel, pose des questions de clarification, fournit des conseils d’expert
interviewer	Interviewer	Pose des questions au lieu de fournir des réponses. Pour les sondages, entretiens et retours

Note

Les champs one_word_description, short_description et ai_commands sont également disponibles via le endpoint Knowledge Base Settings. Ces champs sont partagés : une mise à jour via l’un ou l’autre endpoint modifie les mêmes données sous-jacentes.

Update Chatbot Settings

Scope: write_all

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

Request Body — Tous les champs sont optionnels. N’incluez que les champs que vous souhaitez mettre à jour.

Parameter	Description
personality integer (0–13)	Preset de personnalité de l’IA
profession string	Profession/rôle de l’IA (max 200 caractères)
creativity_level integer (0–2)	0 = Deterministic, 1 = Balanced, 2 = Creative
greeting string	Message de bienvenue principal (HTML, max 1000 caractères)
greeting2 string	Message de bienvenue secondaire
header string	Texte de l’en-tête du chat (max 200 caractères)
header2 string	Texte d’en-tête secondaire (max 200 caractères)
language_chosen string	Codes de langue séparés par des virgules (max 10 caractères au total)
reply_length integer (0–2)	0 = Short, 1 = Medium, 2 = Long
one_word_description string	Nom de l’AI Agent (max 200 caractères)
short_description string	System prompt / description de l’AI Agent (max 2000 caractères)
ai_commands array of strings	AI Guidelines (max 500 caractères par élément)

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 — Retourne les chatbot settings mis à jour (même schéma que la réponse de Get Chatbot Settings).

---