Zum Hauptinhalt springen

Data Push API

Die Data Push API ermöglicht es, Wissen aus beliebigen externen Systemen in den AI Hub zu übertragen. Im Gegensatz zu den anderen Integrationen werden Daten hier nicht vom AI Hub abgerufen, sondern aktiv von einem externen System an den AI Hub gesendet.

Dies eignet sich z. B. für eigene Datenbanken, CRM-Systeme oder andere Quellen, für die keine native Integration zur Verfügung steht.

Einrichtung

1. Collection anlegen

Erstellen Sie im Bereich „Verknüpftes Wissen" eine neue Quelle vom Typ Data Push.

  • Titel: Eindeutiger Name der Collection.
  • Metadaten-Felddefinitionen (optional): Definieren Sie, welche Metadatenfelder externe Systeme beim Senden von Daten mitgeben können. Jedes Feld besteht aus:
    • Key: Feldname (Buchstaben, Zahlen, Unterstriche und Bindestriche; muss mit Buchstabe oder Unterstrich beginnen)
    • Typ: String, Number oder Boolean
    • Pflichtfeld: Ob das Feld bei jedem Push mitgesendet werden muss
warnung

Metadaten-Felddefinitionen können nach dem Erstellen nicht mehr geändert werden.

2. API-Schlüssel erstellen

Über das Aktionsmenü der erstellten Collection kann ein API-Schlüssel generiert werden. Dieser wird einmalig angezeigt und in die Zwischenablage kopiert. Der API-Schlüssel wird für die Authentifizierung bei jedem API-Aufruf benötigt.

3. Collection-ID kopieren

Über das Aktionsmenü kann die Collection-ID kopiert werden. Diese wird als Ziel für die API-Aufrufe benötigt.

API-Nutzung

Die vollständige API-Dokumentation mit allen Endpunkten und Parametern finden Sie in der Swagger OpenAPI Collection.

Ablauf

  1. Collection-ID und API-Schlüssel bereithalten (siehe Einrichtung oben)
  2. Daten per HTTP-Request an die API senden
  3. Die Daten werden automatisch verarbeitet, in Chunks aufgeteilt und als Wissen verfügbar gemacht
tipp

Die Data Push API verwendet keine automatische Synchronisation — Daten werden nur aktualisiert, wenn ein externes System aktiv Inhalte sendet. Gemeinsame Einstellungen wie Chunking und Quellensichtbarkeit werden unter Verknüpftes Wissen beschrieben.