Knowledge Base

La Knowledge Base est le cœur de l’expertise de votre AI Agent — elle contient toutes les informations que votre IA utilise pour répondre aux questions. Ces endpoints vous permettent de gérer la configuration de la Knowledge Base et de déclencher le réentraînement après des changements de contenu.

La Knowledge Base s’appuie sur les Articles que vous créez, importez depuis des sites web ou téléversez sous forme de fichiers. Après avoir modifié des articles, vous devez réentraîner la Knowledge Base pour que les mises à jour prennent effet dans les conversations.

Get Settings

Récupérez la configuration de votre Knowledge Base.

Scope: read_all

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

Shell

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

Python

import requests

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

Response 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "retrain_state": null
}

Field	Description
one_word_description string	Nom de l’AI Agent. Dashboard : Identity > Profile > AI Agent Name
short_description string	System prompt / description de l’AI Agent. Dashboard : Identity > Profile > AI Agent Description
ai_commands array of strings	Consignes comportementales. Dashboard : Identity > Conversation Style > AI Guidelines
retrain_state string or null	Statut d’entraînement actuel : null (à jour ou jamais entraîné), "to_be_retrained", "in_progress", "up_to_date", ou "failed"

Note

Ces trois champs (one_word_description, short_description, ai_commands) sont partagés avec Chatbot Settings. Une mise à jour via l’un ou l’autre endpoint modifie les mêmes données sous-jacentes.

Update Settings

Scope: write_all

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

Request Body

Parameter	Description
one_word_description string	Nom de l’AI Agent
short_description string	System prompt / description de l’AI Agent
ai_commands array of strings	AI Guidelines

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Response 200 OK — Retourne les paramètres de la Knowledge Base mis à jour (même schéma que Get Settings).

Retrain Knowledge Base

Déclenchez un réentraînement asynchrone de la Knowledge Base.

Scope: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retrain/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Response 202 Accepted

Note

Le réentraînement est nécessaire après la publication de modifications d’articles pour garantir que l’AI Agent utilise le contenu le plus récent. Vous pouvez suivre la progression via le champ retrain_state dans Get Settings — il passe de "to_be_retrained" à "in_progress" puis à "up_to_date".

---