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.

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

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

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

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.

Scope: 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 Deprecated

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.

---