Business GPT API
Auf dieser Seite finden Sie die vollständige Referenz der BusinessGPT REST-API mit allen verfügbaren Endpunkten sowie deren Parametern, Anfrage- und Antwortschemata. Sie können die Endpunkte aufklappen, um Details wie benötigte Felder, Datentypen und Beispielantworten einzusehen.
Wie Sie den technischen API-Zugang einrichten und ein Zugriffstoken erhalten, beschreiben die folgenden Anleitungen:
Berechtigungen der API-Rolle
Der technische API-Zugang ("api-User") erhält die Rolle api. Diese Rolle ist
bewusst auf die programmatische Nutzung zugeschnitten und von den Rechten
menschlicher Nutzer (user / admin) abgegrenzt. Die folgende Übersicht zeigt,
welche Funktionsbereiche der API-Rolle grundsätzlich zur Verfügung stehen:
| Funktionsbereich | Zugriff der API-Rolle |
|---|---|
| Chats / Unterhaltungen (Threads und Nachrichten) | Vollzugriff (erstellen, lesen, aktualisieren, löschen) |
| Dokumente | Vollzugriff (lesen, hochladen, aktualisieren, löschen) |
| Dokumenten-Container | Nur lesen |
| Assistenten | Nur lesen |
| Rechtliche Hinweise / Nutzungsbedingungen | Nur lesen |
| Administration (Konfiguration, Gruppen, Funktionen, Verbrauch) | Kein Zugriff |
| Persönliche und unternehmensweite Prompt-Bibliothek | Kein Zugriff |
| Private und persönliche Container | Kein Zugriff |
Effektiver Zugriff hängt von weiteren Faktoren ab
Die Tabelle beschreibt die rollenbasierten Grundrechte der API-Rolle. Der tatsächlich mögliche Zugriff auf einzelne Ressourcen (z. B. bestimmte Dokumenten-Container) wird zusätzlich über Gruppenzugehörigkeiten sowie die Konfiguration Ihrer BusinessGPT-Instanz gesteuert. Maßgeblich ist immer die serverseitige Autorisierung: Endpunkte, für die keine Berechtigung vorliegt, werden mit dem Statuscode 403 Forbidden beantwortet.