Ressourcen · Chat-API

Dokumentation der Chat-API

Unternehmensgerechte Referenz für /chat/completions, inklusive Anfrage-Schema, Streaming-Ereignissen, Laufzeitverhalten und Fehlersemantik.

Zurück zur Dokumentation Zu Endpunkten springen

Endpunkte

GET /api/v1/chat/health

POST /api/v1/chat/completions

Erforderliche Header

Authorization: Bearer [token] oder API-Schlüssel-AuthentifizierungContent-Type: application/jsonX-Scope-Type: personal | workspaceX-Workspace-ID: nur erforderlich, wenn Scope 'workspace' ist

Anfragekörper

json

{
  "message": "Summarize the last meeting in bullet points",
  "session_id": "sess_123",
  "stream": true,
  "attachments": [],
  "metadata": {
    "locale": "en",
    "channel": "web"
  }
}

Antwortkörper

json

{
  "success": true,
  "session_id": "sess_123",
  "content": "• Discussed roadmap\n• Confirmed release scope\n• Assigned owners",
  "provider": "pulse",
  "usage": {
    "input_tokens": 324,
    "output_tokens": 118
  },
  "metadata": {
    "latency_ms": 612
  }
}

Streaming-Ereignisse

response.started — Chat-Ausführung gestartet
response.delta — inkrementelle Text-Token
response.tool_call — Ereignis eines Toolaufrufs (falls vorhanden)
response.usage — Nutzungs-/Token-Aktualisierung
response.completed — endgültige zusammengesetzte Antwort

Laufzeitverhalten

Backpressure-Steuerung lehnt Überlast mit 503 ab.
Verteilte Sperren verhindern doppelte gleichzeitige Verarbeitung.
Dedup-Cache bedient wiederholte Nicht-Streaming-Anfragen.
Sitzungspersistenz speichert Nutzer- und Assistentenbeiträge.
Validierung prüft Anfragekörper, Anhänge und Zugriffskontext.

Fehlermodelle

400

Ungültige Anfrage-Nutzlast oder fehlende Pflichtfelder.

401

Fehlende oder ungültige Authentifizierung.

403

Einschränkung durch Scope/Berechtigung.

409

Sperrkonflikt: Anfrage wird bereits verarbeitet.

422

Validierungsfehler in Header/Body/Kontext.

429

Rate-Limit überschritten.

503

Systemüberlastung oder Nichtverfügbarkeit des Upstreams.

Beispiele

bash

curl -X POST "/api/v1/chat/completions" \
  -H "Authorization: Bearer [token]" \
  -H "Content-Type: application/json" \
  -H "X-Scope-Type: personal" \
  -d '{
    "message":"Write a short product update",
    "session_id":"sess_123",
    "stream":false
  }'