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 suivre le statut de traitement de son 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. Il n’y a aucune étape de réentraînement : chaque article que vous créez, mettez à jour ou supprimez est traité automatiquement en arrière-plan, et prend effet dans les conversations dès que c’est terminé.

Get Settings

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

Portée: 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"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

Field	Description
one_word_description string	Nom de l’AI Agent. Tableau de bord : Identité > Persona IA > Nom
short_description string	System prompt / Prompt principal. Tableau de bord : Identité > Persona IA > Prompt principal
ai_commands array of strings	Directives comportementales, 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.
pending_embed_count integer	Articles encore en cours de traitement. 0 signifie que tout ce que vous avez soumis est en ligne
failed_embed_count integer	Articles dont le traitement a échoué. Relancez-les avec Retry Failed Articles

Attendre la mise en ligne du contenu

Interrogez cet endpoint après une écriture et attendez que pending_embed_count atteigne 0. Le statut par article est également disponible via le champ embed_state des Articles.

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

Portée: 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. 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.

Comment les consignes sont enregistrées

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, une consigne contenant un ; revenait sous la forme de deux consignes distinctes. Si vous évitiez les points-virgules pour contourner ce problème, ce n’est plus nécessaire.

Cet endpoint acceptait auparavant des consignes de n’importe quelle longueur. Les limites ci-dessus s’appliquent désormais ici aussi et correspondent exactement à celles de Chatbot Settings.

Omettez ai_commands, ou envoyez null, pour laisser les consignes inchangées. Envoyez [] pour les effacer.

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

Retry Failed Articles

Relancez le traitement de tous les articles dont le traitement a échoué. Les articles déjà en ligne ou encore en cours ne sont pas touchés, et l’appel peut être répété sans risque.

Les articles en échec sont relancés automatiquement eux aussi : cet endpoint n’est donc utile que si vous ne voulez pas attendre.

Portée: write_all

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

Shell

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

Python

import requests

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

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Nombre d’articles en échec remis en file d’attente pour retraitement

Retrain Knowledge Base Obsolète

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

Le réentraînement n’existe plus — les modifications d’articles sont traitées automatiquement. Cet endpoint n’est conservé que pour que les intégrations existantes continuent de fonctionner : il accepte la requête, ne fait rien, et retourne 200 OK.

Vous pouvez retirer cet appel de votre intégration. Si vous interrogiez l’API jusqu’à la fin du réentraînement, attendez plutôt que pending_embed_count atteigne 0 dans Get Settings.

---