Knowledge Base

Die Wissensdatenbank ist der Kern der Expertise Ihres KI-Agenten — sie enthält alle Informationen, die Ihre KI zum Beantworten von Fragen verwendet. Mit diesen Endpunkten können Sie die Konfiguration der Wissensdatenbank verwalten und den Verarbeitungsstatus ihrer Inhalte verfolgen.

Die Wissensdatenbank schöpft aus Artikeln, die Sie erstellen, von Websites importieren oder als Dateien hochladen. Es gibt keinen Retraining‑Schritt: Jeder Artikel, den Sie erstellen, aktualisieren oder löschen, wird automatisch im Hintergrund verarbeitet und wird in Konversationen wirksam, sobald die Verarbeitung abgeschlossen ist.

Get Settings

Rufen Sie die Konfiguration Ihrer Wissensdatenbank ab.

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

Antwort 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	Name des KI-Agenten. Dashboard: Identity > Profile > AI Agent Name
short_description string	System-Prompt / Beschreibung des KI-Agenten. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Verhaltensrichtlinien. Dashboard: Identity > Conversation Style > AI Guidelines
pending_embed_count integer	Artikel, die noch verarbeitet werden. 0 bedeutet, dass alles, was Sie übermittelt haben, live ist
failed_embed_count integer	Artikel, deren Verarbeitung fehlgeschlagen ist. Wiederholen Sie sie mit Retry Failed Articles

Warten, bis Inhalte live sind

Fragen Sie diesen Endpunkt nach einem Schreibvorgang ab und warten Sie, bis pending_embed_count den Wert 0 erreicht. Der Status pro Artikel steht außerdem als Feld embed_state bei Articles zur Verfügung.

Hinweis

Diese drei Felder (one_word_description, short_description, ai_commands) werden mit Chatbot Settings geteilt. Eine Aktualisierung über einen der beiden Endpunkte ändert dieselben zugrunde liegenden Daten.

Update Settings

Scope: write_all

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

Request-Body

Parameter	Description
one_word_description string	Name des KI-Agenten
short_description string	System-Prompt / Beschreibung des KI-Agenten
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()

Antwort 200 OK — Gibt die aktualisierten Einstellungen der Wissensdatenbank zurück (gleiches Schema wie Get Settings).

Retry Failed Articles

Verarbeitet jeden Artikel neu, dessen Verarbeitung fehlgeschlagen ist. Artikel, die bereits live sind oder noch verarbeitet werden, bleiben unberührt, und der Aufruf kann gefahrlos wiederholt werden.

Fehlgeschlagene Artikel werden auch automatisch erneut verarbeitet — dieser Endpunkt wird also nur benötigt, wenn Sie darauf nicht warten möchten.

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>"},
)

Antwort 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Wie viele fehlgeschlagene Artikel zur erneuten Verarbeitung eingereiht wurden

Retrain Knowledge Base Deprecated

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

Retraining gibt es nicht mehr — Artikeländerungen werden automatisch verarbeitet. Dieser Endpunkt bleibt nur erhalten, damit bestehende Integrationen weiterhin funktionieren: Er nimmt die Anfrage entgegen, tut nichts und gibt 200 OK zurück.

Sie können den Aufruf aus Ihrer Integration entfernen. Falls Sie bisher abgefragt haben, bis das Retraining abgeschlossen war, warten Sie stattdessen, bis pending_embed_count in Get Settings den Wert 0 erreicht.

---