Récupérez et mettez à jour la configuration complète de votre AI Agent via l'API REST.
Chatbot Settings
Section intitulée « 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.
Les paramètres de comportement se trouvent sous Identité > Persona IA dans le tableau de bord. Les textes destinés aux visiteurs se trouvent sous Canaux > Votre site web > Contenu textuel. Le tableau des champs ci-dessous indique l’emplacement exact de chaque paramètre.
Get Chatbot Settings
Section intitulée « Get Chatbot Settings »GET https://app.quickchat.ai/v1/api/chatbot_settings
curl https://app.quickchat.ai/v1/api/chatbot_settings \ -H 'Authorization: Bearer <API_TOKEN>'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. Tableau de bord : Identité > Persona IA > Nom. L’API accepte jusqu’à 200 caractères ; le champ dans l’application est limité à 40. |
short_description string | Le Prompt principal (system prompt). Tableau de bord : Identité > Persona IA > Prompt principal. L’API accepte jusqu’à 25 000 caractères sur toutes les offres ; l’éditeur dans l’application le limite au plafond de votre offre, qui commence à 15 000. |
ai_commands array of strings | Directives comportementales pour l’IA, une directive par élément du tableau. Tableau de bord : Identité > Persona IA > Directives. Jusqu’à 250 éléments, 5 000 caractères par élément et 10 000 caractères au total pour tous les éléments. |
personality integer (0–13) | Preset de personnalité de l’IA. Tableau de bord : Identité > Persona IA > Personnalité. Voir le tableau ci-dessous |
profession string | Profession/rôle de l’IA. Tableau de bord : Identité > Persona IA > Profession (max 200 caractères). Voir le tableau ci-dessous |
creativity_level integer (0–2) | Tableau de bord : Identité > Persona IA > Créativité. 0 = Faible, 1 = Normal, 2 = Élevé |
reply_length integer (0–2) | Tableau de bord : Identité > Persona IA > Longueur de Réponse. 0 = Court, 1 = Normal, 2 = Plus long |
greeting string | Message d’accueil principal (HTML). Tableau de bord : Canaux > Votre site web > Contenu textuel > Message de bienvenue (max 1000 caractères). Il s’agit du même champ que welcome_message dans Widget Configuration. |
greeting2 string | Message d’accueil secondaire (HTML). Disponible via l’API ; aucun champ d’édition ne lui correspond dans le tableau de bord. |
header string | Texte de l’en-tête du chat. Tableau de bord : Canaux > Votre site web > Contenu textuel > Texte d’en-tête (max 200 caractères) |
header2 string | Texte d’en-tête secondaire (max 200 caractères). Disponible via l’API sous le nom header2, ou subtitle dans Widget Configuration ; aucun champ d’édition ne lui correspond dans le tableau de bord. |
language_chosen string | Codes de langue séparés par des virgules (p. ex. "en,es,de"). Tableau de bord : Identité > Persona IA > Langues (max 200 caractères au total ; les codes au-delà de la limite de 30 langues sont ignorés) |
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 |
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
Section intitulée « Update Chatbot Settings »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 = Faible, 1 = Normal, 2 = Élevé |
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 200 caractères au total ; les codes au-delà de la limite de 30 langues sont ignorés) |
reply_length integer (0–2) | 0 = Court, 1 = Normal, 2 = Plus long |
one_word_description string | Nom de l’AI Agent. Maximum de 200 caractères dans l’API ; le champ dans l’application est limité à 40. |
short_description string | System prompt / Prompt principal de l’AI Agent. L’API accepte jusqu’à 25 000 caractères sur toutes les offres ; l’éditeur in-app le limite au plafond de votre offre, qui commence à 15 000. Une valeur trop longue renvoie 422. |
ai_commands array of strings | AI Guidelines, une consigne par élément du tableau. Jusqu’à 250 éléments, 5 000 caractères par élément et 10 000 caractères au total pour tous les éléments. Une valeur trop longue renvoie 422. |
Chaque élément du tableau est une consigne, enregistrée exactement telle que vous l’envoyez. La ponctuation est conservée, y compris les points-virgules. Auparavant, cet endpoint supprimait les ; de votre texte avant l’enregistrement. Si vous les aviez retirés ou remplacés pour contourner ce problème, ce n’est plus nécessaire.
Omettez ai_commands, ou envoyez null, pour laisser les consignes inchangées. Envoyez [] pour les effacer.
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}'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).