Schnelleinstieg für die API
Business GPT lässt sich programmatisch anbinden – etwa um eigene Anwendungen mit den Chat- und Dokumentenfunktionen zu verbinden. Dieser Schnelleinstieg zeigt Ihnen den Weg von der Authentifizierung bis zum ersten API-Aufruf.
1. Zugang einrichten
Der API-Zugang erfolgt über das Identitätssystem Ihres Unternehmens per OAuth2 (Client Credentials). Wählen Sie die zu Ihrer Umgebung passende Anleitung:
Beide Anleitungen führen Sie durch die Registrierung der Anwendung, die OAuth2-Konfiguration und einen ersten Testaufruf.
2. Berechtigungen verstehen
API-Zugriffe erfolgen über die API-Rolle. Diese hat einen klar abgegrenzten Funktionsumfang (z. B. Vollzugriff auf Chats und Dokumente, nur lesenden Zugriff auf Container und Assistenten). Verschaffen Sie sich vorab einen Überblick.
3. Endpunkte erkunden
Die vollständige, interaktive Referenz aller verfügbaren Endpunkte finden Sie in der API-Dokumentation. Dort sehen Sie Anfragen, Parameter und Antwortformate im Detail.