Licensed to be used in conjunction with basebox, only.
// integration
OpenAI-API-Integration
Gilt für
Produkt: Cloud · Server · Zielgruppe: Entwickler / Integrator
Mit der OpenAI-kompatiblen API von basebox nutzen Sie jedes Werkzeug, jede Bibliothek und jede Anwendung, die für die OpenAI-API entwickelt wurde, mit Ihrer eigenen basebox-Instanz.
Die OpenAI-kompatible API ist immer verfügbar – sie muss nicht mehr eingeschaltet werden und ist Teil jeder basebox-Installation. Für Anthropic-Modelle fügt basebox den Anfragen keine zusätzlichen Instruktionen hinzu.
🚀 Schnellstart
Neu bei der OpenAI-API? Beginnen Sie hier:
- Quickstart – API-Schlüssel, Basis-URL und Realm; die erste Chat-Completion mit curl und dem OpenAI-SDK
- Benutzerhandbuch – Vollständige technische Dokumentation mit Beispielen
- IDE-Integration – Ihren bevorzugten Code-Editor mit basebox verbinden
- OpenClaw-Integration – basebox mit OpenClaw für KI-Coding-Workflows nutzen
🎯 Was können Sie tun?
Mit der OpenAI-kompatiblen API können Sie:
- jedes OpenAI-kompatible Werkzeug mit Ihren eigenen Modellen nutzen
- KI in Ihren Entwicklungs-Workflow integrieren (VS Code, Zed, Neovim etc.)
- eigene Anwendungen bauen mit den vertrauten OpenAI-Bibliotheken
- testen und prototypen mit der interaktiven Swagger-UI
- Datenschutz und Kontrolle behalten, während Sie gängige KI-Werkzeuge nutzen
- Denkmodi über die API nutzen – siehe Reasoning-Aufwand
📖 Dokumentationsübersicht
Für Einsteiger
- Quickstart – Hier beginnen
- Release 1.7.0 – Was mit basebox 1.7.0 an der API neu war
- Benutzerhandbuch – Erste Schritte – Ihr erstes API-Token erhalten
Für Entwickler
- Benutzerhandbuch – Vollständige API-Referenz mit curl-Beispielen
- Test mit Swagger-UI – Interaktives API-Testen
- Häufige Fehler – Diese Fallstricke vermeiden
Für die Werkzeug-Integration
- IDE-Integration – Zed, VS Code, Neovim und mehr verbinden
- OpenClaw-Integration – Integration eines KI-Coding-Agenten
🔧 Schnelle Beispiele
Verbindung testen
curl -H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-Realm: YOUR_REALM" \
https://your-basebox.example.com/v1/models
Einfache Chat-Anfrage
curl -X POST "https://your-basebox.example.com/v1/chat/completions" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-Realm: YOUR_REALM" \
-d '{
"model": "claude-sonnet-4",
"messages": [
{"role": "user", "content": "Hello, what model are you?"}
]
}'
Interaktiv testen
Öffnen Sie https://your-basebox.example.com/v1/api/docs für die Swagger-UI-Testoberfläche.
🆘 Hilfe nötig?
- Fehlerbehandlung: Statuscodes, Meldungen und Client-Verhalten unter Fehlerbehandlung
- Troubleshooting: Siehe den Abschnitt Troubleshooting im Benutzerhandbuch
- Häufige Probleme: Siehe die häufigen Fehler im Benutzerhandbuch
- API-Referenz: Alle Details im Benutzerhandbuch
🌟 Beliebte Anwendungsfälle
- Code-Assistenz: GitHub Copilot, Cursor oder ähnliche Werkzeuge mit Ihren Modellen nutzen
- Eigene Anwendungen: Chatbots, Content-Generatoren oder Analysewerkzeuge bauen
- Entwicklungs-Workflow: KI direkt in den Editor integrieren
- Team-Werkzeuge: Organisationsspezifische KI-gestützte Hilfsmittel erstellen
Die interaktive Swagger-UI steht unter /v1/api/docs auf Ihrer basebox-Instanz.
Nächster Schritt: Quickstart · Benutzerhandbuch
Benötigen Sie Hilfe? Support kontaktieren