Dokumentation / Entwicklung

Eine API. Ihr nächster Schritt.

Authentifizieren Sie Anfragen, finden Sie Modelle und integrieren Sie Ihre erste Unterhaltung. Die Beispiele laufen auf dem Server.

Verwenden Sie einen CONSTELLO-API-Schlüssel und ein für Ihr Konto verfügbares Modell. Ausgeführte Anfragen verbrauchen Guthaben entsprechend der Nutzung.

Schnellstart

Erstellen Sie Ihr Konto auf gateway.constello.ch, laden Sie bei Bedarf Guthaben auf und erstellen Sie unter API-Schlüssel einen Schlüssel. Wählen Sie eine Kennung unter KI-Modelle oder über GET /v1/models. Setzen Sie diese Variablen im Terminal.

BASE URLhttps://gateway.constello.ch/v1
Shell 
export GATEWAY_URL="https://gateway.constello.ch"
export GATEWAY_API_KEY="YOUR_GATEWAY_TOKEN"
export GATEWAY_MODEL="YOUR_MODEL_ID"

Bash-/zsh-Syntax. Ersetzen Sie die Platzhalter. Die Python- und JavaScript-Beispiele verwenden dieselben Umgebungsvariablen.

Setzen Sie in einem OpenAI-kompatiblen SDK base_url oder baseURL auf https://gateway.constello.ch/v1. In diesen Beispielen bezeichnet GATEWAY_URL die Wurzel ohne /v1; die Anfragepfade ergänzen dieses Präfix.

Authentifizierung

Senden Sie Ihren CONSTELLO-API-Schlüssel im Authorization-Header. Verwenden Sie einen API-Schlüssel, niemals Ihr Kontopasswort.

Authorization: Bearer YOUR_GATEWAY_TOKEN

Speichern Sie den Schlüssel in Umgebungsvariablen Ihres Servers oder lokalen Werkzeugs. Binden Sie ihn nicht in öffentliches JavaScript ein und speichern Sie ihn nicht in Git. Verwenden Sie ausschliesslich die HTTPS-Adresse der Gateway.

Modelle

GET/v1/models

Listen Sie die mit Ihrem Schlüssel verfügbaren Modelle auf. Übernehmen Sie eine zurückgegebene Kennung exakt in das Feld model Ihrer Anfrage.

cURL 
curl "$GATEWAY_URL/v1/models" \
  -H "Authorization: Bearer $GATEWAY_API_KEY"

Chat-Anfragen

POST/v1/chat/completions

Senden Sie ein Nachrichten-Array an ein konfiguriertes Modell. Diese Beispiele liefern eine vollständige Antwort ohne Streaming. Python verwendet die Standardbibliothek; JavaScript benötigt Node.js 18 oder neuer.

Feld Typ Beschreibung
model string Erforderlich. Exakte ID eines konfigurierten Modells.
messages array Erforderlich. Nachrichten mit role und content.
stream boolean Optional. true für eine schrittweise Antwort.

Streaming

Setzen Sie stream: true und verwenden Sie einen Client, der SSE-Ereignisse lesen kann. Bei cURL deaktiviert -N die Ausgabepufferung.

cURL / SSE 
curl -N "$GATEWAY_URL/v1/chat/completions" \
  -H "Authorization: Bearer $GATEWAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"YOUR_MODEL_ID","messages":[{"role":"user","content":"Hello"}],"stream":true}'

Ersetzen Sie YOUR_MODEL_ID durch eine für Ihr Konto verfügbare Kennung. Behandeln Sie Unterbrechungen und Fehler im Stream. Streaming hängt vom Modell ab.

Fehler beheben

Prüfen Sie HTTP-Status, Fehlermeldung und Gateway-Protokolle. Teilen Sie keine Authentifizierungsheader in Fehlerberichten.

Zugriff verweigert

Prüfen Sie Token, Status, Ablaufdatum und Einschränkungen.

Kontingent oder Limit erreicht

Prüfen Sie Guthaben, Schlüsselkontingent und Anfragelimits. Vergrössern Sie bei einer vorübergehenden Begrenzung die Abstände zwischen Anfragen.

Modell nicht verfügbar

Prüfen Sie Modellkennung und Schlüsselbeschränkungen. Prüfen Sie den Dienststatus und kontaktieren Sie bei anhaltenden Problemen den Support; senden Sie niemals Ihren Schlüssel.

Konsole öffnen