companyRAG API

Der companyRAG Indexer stellt eine HTTP-API bereit, über die Dateien, Sammlungen, Indexierungs-Jobs und Datenquellen programmatisch verwaltet werden können. Damit lassen sich Inhalte automatisiert in companyRAG einpflegen, etwa aus einem bestehenden Dokumentenmanagement oder über einen nächtlichen Abgleich.

Diese Seite beschreibt die Grundlagen: Authentifizierung, Basis-URL und Fehlerbehandlung. Die Referenz der Endpunkte wird aus der OpenAPI-Spezifikation erzeugt. Sie deckt die wichtigsten Endpunkte ab; einige neuere Endpunkte und Felder fehlen dort noch.

companyRAG API ReferenceDie wichtigsten Endpunkte mit Parametern, Request- und Response-Schemas sowie Code-Beispielen – generiert aus der OpenAPI-Spezifikation.

Hinweis

Die generierte Referenz ist englischsprachig, da sie unmittelbar aus der OpenAPI-Spezifikation erzeugt wird.

Authentifizierung

Alle Endpunkte erfordern eine Authentifizierung über einen API-Schlüssel. Der Schlüssel wird im Authorization-Header als Bearer Token übermittelt:

Authorization: Bearer rag_a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890

API-Schlüssel erzeugen Administratoren in companyRAG unter API-Schlüssel. Sie haben das Format rag_ gefolgt von einem 64-stelligen Hex-String und handeln immer im Namen der Person, die sie erstellt hat.

Alternativ akzeptiert die API ein access_token-Cookie. Dieser Weg ist als Fallback für Browser-Clients gedacht, die bereits an companyRAG angemeldet sind; für Integrationen und Skripte ist der Bearer Token vorgesehen.

Basis-URL

Die API ist unter der Domain der jeweiligen CompanyGPT-Instanz erreichbar:

https://FIRMA.company-gpt.com/companygpt/rag/api

FIRMA ist ein Platzhalter für die Subdomain Ihrer Umgebung. Sie lässt sich der Adressleiste des Browsers entnehmen, wenn die companyRAG-Oberfläche geöffnet ist. Nutzt Ihre Umgebung eine eigene Domain, hängen Sie /companygpt/rag/api an diese Domain an.

Fehlerbehandlung

Fehler werden überwiegend als JSON-Objekt mit einem error-Feld zurückgegeben:

{
  "error": "Error message description"
}

Einige Endpunkte antworten stattdessen mit einem Klartext-Body; diese sind in der Referenz beim jeweiligen Endpunkt vermerkt.

Status	Bedeutung
400 Bad Request	Ungültige Anfrageparameter
401 Unauthorized	Fehlende oder ungültige Authentifizierung
403 Forbidden	Unzureichende Berechtigungen
404 Not Found	Ressource nicht gefunden
409 Conflict	Konflikt mit dem aktuellen Zustand der Ressource, etwa ein Job, der im derzeitigen Status nicht wiederholt werden kann, oder eine Freigabeänderung, nach der eine Sammlung keinen Besitzer mehr hätte
500 Internal Server Error	Serverseitiger Fehler

Funktionsbereiche

Die Endpunkte sind in der Referenz nach Bereichen gruppiert:

• Files – Dateien hochladen, auflisten, abrufen, löschen und neu indexieren.
• Jobs – Indexierungs-Jobs überwachen, wiederholen, abbrechen und aufräumen.
• Collections – Sammlungen anlegen, bearbeiten, löschen und ihre Freigaben verwalten.
• Ingest – Strukturierte Datensätze zeilenweise einpflegen (bis zu 10.000 Zeilen pro Aufruf) und Tabellen leeren.
• Sources – Datenquellen wie SharePoint, Nextcloud, Google Drive, GitHub, WebDAV, FTP oder Web-Crawl konfigurieren und synchronisieren.
• Admin – API Keys – API-Schlüssel auflisten, erstellen und widerrufen (nur für Administratoren).

Weitere Ressourcen

• companyRAG Addon – Funktionsumfang und Bedienung der Oberfläche
• companyRAG in CompanyGPT nutzen – Einrichtung als Wissensquelle für Agenten
• Agents API – programmatischer Zugriff auf CompanyGPT-Agenten