Licensed to be used in conjunction with basebox, only.
// integration
basebox REST API – Übersicht
Gilt für
Produkt: Cloud · Server · Zielgruppe: Entwickler / Integrator
basebox stellt eine REST-API bereit, die die Integration von Drittsystemen und -diensten ermöglicht. Sie orientiert sich an der OpenAI REST API, unterstützt aber nicht alle Endpunkte und Funktionen.
Wenn Ihnen etwas fehlt, senden Sie Ihre Anfrage an support@bbox.
Basis-URL
Alle REST-API-Anfragen verwenden eine der folgenden Basis-URLs, abhängig von Ihrem Deployment:
| Deployment | Basis-URL |
|---|---|
| Cloud | https://aims.basebox.ai/rest/v1 |
| basebox Server | https://<dein-ingress-host>/rest/v1 |
Auf basebox Server ersetzen Sie <dein-ingress-host> durch den Ingress-Host Ihrer basebox-Instanz (in der Regel der Hostname, über den Sie das basebox.ai-Frontend erreichen).
Voraussetzungen
Die REST-API ist eine optionale Funktion; Ihre basebox-Lizenz muss ihre Nutzung abdecken. Auf basebox Server müssen Sie zusätzlich sicherstellen, dass die Umgebungsvariable AISRV_ENABLE_REST_API auf true gesetzt ist.
Authentifizierung
Alle Anfragen an die REST-API müssen authentifiziert sein. Sie authentifizieren sich mit einem API-Schlüssel, der als Bearer-Token an den Server übergeben wird. API-Tokens erstellen Sie im basebox-Administrationsbereich.
Mehr dazu im Abschnitt Authentifizierung.
API-Host
Für Cloud-Nutzer lautet der API-Host aims.basebox.ai; auf basebox Server fragen Sie Ihren Platform Operator. In der Regel können Sie den Hostname verwenden, über den Sie das basebox.ai-Frontend erreichen.
Der Pfad zur REST-API ist immer /rest/v1.