# API

!!! tip "Du brauchst nur Zugriff auf die Modelle?"

    Wenn du aus deinem eigenen Code nur Anfragen an ein Sprachmodell schicken willst, nutze stattdessen
    [Aqueduct](https://datalab.tuwien.ac.at/de/aiml/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 { #getting-started }

### Schritt 1: Persönlichen API-Key bekommen { #step-1-get-a-personal-api-key }

API-Keys für Open WebUI sind **standardmäßig nicht freigeschaltet**. Wenn du einen brauchst, melde dich im
[Matrix-Raum](https://matrix.to/#/#llm-service:tuwien.ac.at) und schreib uns, wofür du ihn nutzen willst. Sobald er für
deinen Account freigeschaltet ist:

1. Öffne die **Einstellungen** (Zahnrad) in Open WebUI
2. Wähle den Tab **Account**
3. Klicke auf **„Create API Key"**
4. 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 { #step-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](https://docs.openwebui.com/reference/api-endpoints) in
der offiziellen Dokumentation.

### Schritt 3: Anfragen senden { #step-3-making-api-requests }

**cURL-Beispiel:**

```bash
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):**

```python
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) { #knowledge-bases-rag }

Über die API kannst du das Hochladen vieler Dateien in eine [Wissensdatenbank](https://datalab.tuwien.ac.at/de/aiml/openwebui/documents/#knowledge-bases)
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 { #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](https://datalab.tuwien.ac.at/de/aiml/aqueduct/) und frag im
  [Matrix-Raum](https://matrix.to/#/#llm-service:tuwien.ac.at) nach einem Service-Account