Articles

Artikel sind die Bausteine der Wissensdatenbank Ihres KI-Agenten. Jeder Artikel stellt ein Stück Wissen dar — eine Hilfeseite, einen FAQ-Eintrag, eine Produktbeschreibung oder jeden Inhalt, den Ihre KI kennen sollte.

Es gibt drei Artikeltypen: Articles (vollständige Dokumente mit Titel und Inhalt), Paragraphs (kurze, eigenständige Texteinträge) und URL-Artikel (automatisch erstellt beim Import von Webinhalten). Sie können Artikel manuell über die API erstellen, sie mit Import External Content von Websites importieren, Dateien über File Upload hochladen oder von Intercom synchronisieren.

Nachdem Sie Artikel erstellt oder aktualisiert haben, denken Sie daran, die Wissensdatenbank neu zu trainieren, damit die Änderungen wirksam werden.

Create Article

Scope: write_all

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

Request-Body

Parameter	Description
content string, required	Artikelinhalt
type string	"Article" (Standard) oder "Paragraph"
title string	Artikeltitel

Artikeltypen

• "Article" — Ein vollständiges Knowledge-Base-Dokument mit Titel und Inhalt. Für FAQ-Einträge, Hilfeartikel, Produktbeschreibungen.
• "Paragraph" — Ein kurzer, eigenständiger Texteintrag ohne Titel. Für knappe Fakten, Einzeiler-Antworten, Schnellreferenzdaten.
• "URL" (read-only) — Wird automatisch erstellt, wenn Inhalte von einer Website importiert werden. Enthält den gescrapten Seiteninhalt mit der Quell-URL. Kann bei der Erstellung nicht gesetzt werden.

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "Our return policy allows returns within 30 days.",
  "title": "Return Policy"
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "content": "Our return policy allows returns within 30 days.",
        "title": "Return Policy",
    },
)
data = response.json()

Antwort 201 Created

{
  "id": 1234,
  "article_id": "abc-123",
  "type": "Article",
  "title": "Return Policy",
  "description": "",
  "content": "Our return policy allows returns within 30 days.",
  "state": "draft",
  "deploy_state": "draft",
  "version": null,
  "max_available_version": null,
  "url": null,
  "tags": [],
  "created_timestamp": "2026-01-15",
  "last_modified_timestamp": "2026-01-15",
  "downloaded_timestamp": "2026-01-15",
  "last_updated_timestamp": "2026-01-15",
  "last_updated_from_external_source_timestamp": null
}

Field	Description
id integer	Numerische Artikel-ID. Dies ist der kanonische Identifier, der in allen URL-Pfaden verwendet wird
article_id string	Legacy-String-Identifier. Kann leer sein — verwenden Sie stattdessen id
type string	"Article", "Paragraph" oder "URL"
title string	Artikeltitel
description string	Artikelbeschreibung
content string	Artikelinhalt
deploy_state string	"draft" oder "published" — steuert die Sichtbarkeit des Artikels
state string	Interner Verarbeitungsstatus (siehe Hinweis unten)
version integer or null	Aktuelle Versionsnummer
max_available_version integer or null	Höchste verfügbare Version
url string or null	Quell-URL (für Artikel vom Typ URL)
tags array of strings	Zugeordnete Tags
created_timestamp string	Erstellungsdatum
last_modified_timestamp string	Datum der letzten Änderung
downloaded_timestamp string	Download-Datum
last_updated_timestamp string	Datum der letzten Aktualisierung
last_updated_from_external_source_timestamp string or null	Letzte Aktualisierung aus externer Quelle

Artikel-States verstehen

Artikel haben zwei State-Felder:

• deploy_state: Steuert, ob der Artikel ein "draft" oder "published" ist. Dies ist das primäre Feld, das Sie zur Verwaltung der Artikelsichtbarkeit verwenden sollten.
• state: Spiegelt den internen Verarbeitungsstatus wider. Für die meisten API-Nutzer kann dieses Feld ignoriert werden — es verfolgt Backend-Verarbeitungsschritte und kann Werte wie "done" oder "published" anzeigen.

List Articles

Scope: read_all

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

Query-Parameter

Parameter	Description
limit integer	Elemente pro Seite
offset integer	Zu überspringende Elemente
types string	Nach Typ filtern: Article, Paragraph, URL
tags string	Nach Tag filtern
url string	Nach URL filtern
title string	Nach Titel filtern
query string	Nach Inhalt suchen

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/?limit=10&offset=0' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

Antwort 200 OK

{
  "items": [
    {
      "id": 1234,
      "article_id": "abc-123",
      "type": "Article",
      "title": "Return Policy",
      "description": "",
      "state": "published",
      "deploy_state": "published",
      "version": 1,
      "max_available_version": 1,
      "url": null,
      "tags": ["policies"],
      "created_timestamp": "2026-01-15",
      "last_modified_timestamp": "2026-01-15",
      "downloaded_timestamp": "2026-01-15",
      "last_updated_timestamp": "2026-01-15",
      "last_updated_from_external_source_timestamp": null
    }
  ],
  "offset": 0,
  "limit": 10,
  "count": 1
}

Hinweis

Die Listenantwort enthält das Feld content nicht. Verwenden Sie Get Article, um den vollständigen Inhalt eines bestimmten Artikels abzurufen.

Get Article

Scope: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

Shell

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

Python

import requests

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

Antwort 200 OK — Gibt das vollständige Artikelobjekt zurück (gleiches Schema wie die Antwort von Create Article), einschließlich des Feldes content.

Update Article

Scope: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/{article_id}

Request-Body

Parameter	Description
content string	Aktualisierter Artikelinhalt
title string	Aktualisierter Titel
tags array of strings	Aktualisierte Tags
save_mode string	"draft" (Standard) oder "publish"

Achtung

Die Option save_mode: "draft" setzt nur das Flag deploy_state — sie verhindert nicht, dass der Artikelinhalt von der KI verwendet wird, sobald die Wissensdatenbank neu trainiert wurde. Verwenden Sie für programmatische Workflows save_mode: "publish" und lösen Sie ein Retraining aus, wenn Sie bereit sind, dass die Änderungen wirksam werden.

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/articles/1234 \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Updated Return Policy",
  "content": "Returns accepted within 60 days.",
  "save_mode": "publish"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/1234",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "title": "Updated Return Policy",
        "content": "Returns accepted within 60 days.",
        "save_mode": "publish",
    },
)
data = response.json()

Antwort 200 OK — Gibt das aktualisierte Artikelobjekt zurück.

Delete Articles

Einen oder mehrere Artikel anhand der ID löschen.

Scope: write_all

DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/

Request-Body — JSON-Array mit Artikel-IDs.

Shell

curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/articles/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '[1234, 5678]'

Python

import requests

response = requests.delete(
    url="https://app.quickchat.ai/v1/api/knowledge_base/articles/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json=[1234, 5678],
)

Antwort 200 OK

Search Articles

Artikelinhalte mit Textabgleich durchsuchen.

Scope: read_all

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

Query-Parameter

Parameter	Description
query string, required	Suchanfrage
is_case_insensitive boolean	Suche ohne Beachtung der Groß-/Kleinschreibung (Standard: true)
with_title_url_and_tags boolean	Titel/URL/Tags in die Suche einbeziehen (Standard: true)
strict_search boolean	Exakte Übereinstimmung erfordern (Standard: false)
num_of_display_articles integer	Anzahl der anzuzeigenden Artikel (Standard: 5)
num_of_data_articles integer	Anzahl der zu durchsuchenden Artikel (Standard: 15)

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/search?query=return%20policy' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

Antwort 200 OK

{
  "article_snippets": [
    {
      "article_id": 1234,
      "expository_sentence": "Our return policy allows returns within 30 days.",
      "query_words_ids": [
        {"start_char": 4, "end_char": 10, "text": "return"}
      ]
    }
  ],
  "article_snapshots": {
    "items": [],
    "offset": 0,
    "count": 1
  }
}

List Paragraphs

Alle Artikel vom Typ Paragraph auflisten. Paragraphs sind kurze, eigenständige Texteinträge ohne Titel — im Gegensatz zu vollständigen Articles, die sowohl einen Titel als auch einen Inhaltskörper haben.

Scope: read_all

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

Query-Parameter

Parameter	Description
limit integer	Elemente pro Seite
offset integer	Zu überspringende Elemente
query string	Nach Inhalt filtern

Shell

curl 'https://app.quickchat.ai/v1/api/knowledge_base/articles/paragraphs?limit=10' \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

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

Antwort 200 OK

{
  "items": [
    {
      "id": 1,
      "content": "Our return policy allows returns within 30 days."
    }
  ],
  "offset": 0,
  "count": 1
}

---