API¶
Du brauchst nur Zugriff auf die Modelle?
Wenn du aus deinem eigenen Code nur Anfragen an ein Sprachmodell schicken willst, nutze stattdessen Aqueduct, das API-Gateway für die KI-Services der TU Wien. Die Open-WebUI-API ist vor allem dann nützlich, wenn du Funktionen von Open WebUI, etwa deine Wissensdatenbanken, aus einem Skript nutzen willst.
Loslegen¶
Schritt 1: Persönlichen API-Key bekommen¶
API-Keys für Open WebUI sind standardmäßig nicht freigeschaltet. Wenn du einen brauchst, melde dich im Matrix-Raum und schreib uns, wofür du ihn nutzen willst. Sobald er für deinen Account freigeschaltet ist:
- Öffne die Einstellungen (Zahnrad) in Open WebUI
- Wähle den Tab Account
- Klicke auf „Create API Key"
- Kopiere den Key und bewahre ihn sicher auf (z. B. in einem Passwortmanager)
Achtung: Behandle deinen API-Key wie ein Passwort! Gib ihn nicht weiter und schreib ihn nicht in öffentlich zugänglichen Code.
Schritt 2: Endpoints¶
Alle Endpoints sind relativ zu https://chat.ai.datalab.tuwien.ac.at:
| Was | Endpoint |
|---|---|
| Modelle auflisten (inklusive deiner Assistenten) | GET /api/models |
| Chat Completions | POST /api/chat/completions |
| Datei hochladen | POST /api/v1/files/ |
| Datei zu einer Wissensdatenbank hinzufügen | POST /api/v1/knowledge/{id}/file/add |
Details und weitere Endpoints findest du unter API Endpoints in der offiziellen Dokumentation.
Schritt 3: Anfragen senden¶
cURL-Beispiel:
curl -X POST https://chat.ai.datalab.tuwien.ac.at/api/chat/completions \
-H "Authorization: Bearer $OPENWEBUI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen-3.8-27b",
"messages": [
{"role": "user", "content": "Erkläre die Rayleigh-Streuung in drei Sätzen."}
]
}'
Python-Beispiel (mit der openai-Library):
import os
from openai import OpenAI
client = OpenAI(
base_url="https://chat.ai.datalab.tuwien.ac.at/api",
api_key=os.environ["OPENWEBUI_API_KEY"],
)
chat_completion = client.chat.completions.create(
model="qwen-3.8-27b",
messages=[
{"role": "user", "content": "Erkläre die Rayleigh-Streuung in drei Sätzen."},
],
)
print(chat_completion.choices[0].message.content)
Wissensdatenbanken (RAG)¶
Über die API kannst du das Hochladen vieler Dateien in eine Wissensdatenbank
automatisieren: lade jede Datei mit POST /api/v1/files/ hoch und füge sie dann mit
POST /api/v1/knowledge/{id}/file/add zur Wissensdatenbank hinzu.
Best Practices¶
- Keys nicht in den Code: lies sie aus Umgebungsvariablen
- Fehler behandeln: rechne mit Authentifizierungsfehlern (
401), Rate Limiting (429) und unbekannten Modell-IDs - Große Jobs: für große automatisierte Verarbeitung nutze Aqueduct und frag im Matrix-Raum nach einem Service-Account