Dokumentation

API-Referenz

Authentifizierung, die OpenAI-kompatible Endpoint-Oberfläche, Streaming, Reasoning und die Fehler-Taxonomie.

Authentifizierung

Jede Anfrage an /v1/* authentifiziert sich mit einem virtuellen Key im Header Authorization: Bearer. Erzeugen Sie Keys in der Console; das Secret wird nur einmal angezeigt und nur sein Hash wird gespeichert. Ein Key trägt eigene Rate-Limits, ein Budget, Tags, eine optionale Modell-Allow-List (leer = jedes Modell) und spärliche option_overrides, die von der Organisations-Policy abweichen (Datenschutzmodus, NER-Modell, Injection-Scan-Modus).

Eine Anfrage, deren Modell nicht auf der nicht leeren Allow-List des Keys steht, wird mit einem versiegelten 403 permission_error abgewiesen, bevor irgendetwas versendet wird; die Abweisung selbst landet in der Audit-Kette.

Das Erzeugen eines Produktions-Keys erfordert eine verifizierte E-Mail-Adresse.

curl https://api.sluis.ai/v1/models \
  -H "Authorization: Bearer $SLUIS_KEY"

# a model outside the key's allow-list never dispatches:
# → 403 permission_error · the refusal is sealed in the audit chain

Endpunkte

Sluis stellt die unten stehende OpenAI-kompatible Oberfläche bereit. Endpunkte ohne First-Class-Handler werden unverändert an den gerouteten Anbieter weitergereicht, Streaming inbegriffen, sodass OpenAI-kompatible Upstreams volle Fidelität behalten.

EndpunktZweck
POST /v1/chat/completionsChat Completions, die primäre Oberfläche: Routing, Datenschutz, Caching, Streaming.
POST /v1/completionsLegacy-Text-Completions.
POST /v1/embeddingsEmbeddings; speist auch den semantischen Cache.
POST /v1/moderationsModerations-Klassifikation.
POST /v1/responsesDie OpenAI Responses API.
POST /v1/ocrDokument-OCR (Mistral, oder vollständig lokal mit dem Modell sluis/ocr) · pro Seite abgerechnet. Mit aktiver dlp_documents-Policy werden Inline-Dokumente vor dem Versand anonymisiert.
POST /v1/documents/anonymizeDokument-Anonymisierung · PII werden zu «MERGE_TAG»s, Bilder werden unkenntlich gemacht · pro Seite/Bild abgerechnet.
POST /v1/documents/anonymize/jobsAsynchrone Anonymisierungs-Jobs · große Dokumente einreihen, Status abfragen, Ergebnis über eine zeitlich begrenzte signierte URL ohne API-Schlüssel abholen.
GET /v1/modelsDie Modelle, die Ihre Policy und Ihre Zugangsdaten tatsächlich erreichen können, nichts Hypothetisches.
GET /v1/models/{id}Die Metadaten eines Modells.
POST /v1/audio/*Transkription, Übersetzung, Sprache · an den gerouteten Anbieter weitergereicht.
POST /v1/images/*Bildgenerierung und -bearbeitung · weitergereicht.
POST /v1/video/generationsVideogenerierung · weitergereicht.
/v1/filesDateioperationen · weitergereicht.
POST /v1/messagesNativer Anthropic-Messages-Ingress · richten Sie jedes Anthropic-SDK-Tool auf Sluis; jedes verbundene Modell.
POST /v1/messages/count_tokensLokale Token-Schätzung für das Kontextmanagement des Anthropic SDK; nichts wird versendet.
POST /v1beta/models/{model}:generateContentNativer Google-Gemini-Ingress · richten Sie ein Gemini-SDK auf Sluis (:streamGenerateContent streamt).
curl https://api.sluis.ai/v1/chat/completions \
  -H "Authorization: Bearer $SLUIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "model": "mistral/mistral-large-latest",
        "messages": [{ "role": "user", "content": "Say hi" }] }'
# Document OCR, billed per page. Returns pages[] markdown + usage_info.pages_processed.
# model "sluis/ocr" runs the gateway's own OCR engine: fully local, no provider egress (inline data: URLs only).
curl https://api.sluis.ai/v1/ocr \
  -H "Authorization: Bearer $SLUIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "model": "mistral/mistral-ocr-latest", "document": { "type": "document_url", "document_url": "https://example.com/invoice.pdf" } }'
# Document anonymization, billed per page/image. PII becomes «MERGE_TAG»s; images are blurred.
curl https://api.sluis.ai/v1/documents/anonymize \
  -H "Authorization: Bearer $SLUIS_KEY" \
  -F file=@contract.docx \
  -F 'options={ "entities": ["person_name", "email", "iban"], "include_mapping": true }'

Dokumente als Eingabe

Hängen Sie ein PDF, Word-Dokument, Bild oder eine Textdatei als Content-Part "type": "file" mit einer base64-file_data-Daten-URL an eine Chat-Anfrage an. Jedes geroutete Modell akzeptiert das: Anbieter, die File-Parts nativ verstehen, erhalten sie unverändert, und für alle anderen konvertiert das Gateway das Dokument vor dem Versand. Anbieterseitige file_id-Referenzen werden nicht aufgelöst; betten Sie die Bytes als file_data ein.

Modelle mit Bildeingabe erhalten jede PDF-Seite als image_url-Part gerendert (48-Seiten-Budget pro Anfrage, geteilt über alle angehängten Dokumente); Modelle ohne Bildeingabe erhalten den extrahierbaren Text des Dokuments als Prompt-Text, den der Datenschutz-Scan dann wie jeden anderen Text abdeckt. Längere oder schwerere Dokumente gehören auf /v1/ocr. Mit aktivierter dlp_documents-Richtlinie wird das Dokument anonymisiert oder abgelehnt, bevor irgendetwas das Gateway verlässt. Ist sie aus und der DLP-Modus der Organisation schützend (tokenize, mask oder block), werden Dokumente, die als nicht inspizierbare Bilder reisen würden, abgelehnt; unter allow_log passieren sie mit einer expliziten Ungeprüft-Markierung im Audit-Protokoll.

# Attach a document as an OpenAI-style `file` content part. The gateway
# normalizes it for the routed provider, so this works on any model.
curl https://api.sluis.ai/v1/chat/completions \
  -H "Authorization: Bearer $SLUIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "model": "scaleway/gemma-4-26b-a4b-it",
        "messages": [{ "role": "user", "content": [
          { "type": "file",
            "file": { "filename": "drawing.pdf",
                      "file_data": "data:application/pdf;base64,'"$(base64 -w0 drawing.pdf)"'" } },
          { "type": "text", "text": "Which discipline does this drawing document?" }
        ] }] }'

Streaming

Setzen Sie stream: true und die Antwort kommt als Server-Sent Events: jedes Frame ist ein chat.completion.chunk-Delta, und der Stream endet mit data: [DONE]. Streams werden im Gateway nie gepuffert: sie werden durchgeschleust, und Audit-Siegel und Metering erfolgen selbst dann, wenn der Client früh auflegt.

Fordern Sie stream_options.include_usage an, und das letzte Frame trägt die exakte Token-Nutzung, dieselben Zahlen, die das Gateway zählt und abrechnet.

stream = client.chat.completions.create(
    model="mistral/mistral-large-latest",
    messages=[{"role": "user", "content": "Write a haiku"}],
    stream=True,
    stream_options={"include_usage": True},
)
for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

Reasoning

Übergeben Sie den OpenAI-Parameter reasoning_effort (minimal | low | medium | high) bei jedem reasoning-fähigen Modell. Sluis übersetzt ihn je Anbieter (Geminis Thinking-Level, Claudes adaptiver Thinking-Effort) und lässt ihn weg, wo ein Modell ihn ablehnen würde, sodass ein einziger Parameter über den gesamten Katalog funktioniert.

resp = client.chat.completions.create(
    model="vertex/claude-opus-4-8",
    messages=[{"role": "user", "content": "Prove it step by step…"}],
    reasoning_effort="high",  # minimal | low | medium | high
)

Fehlercodes

Fehler verwenden das OpenAI-Fehler-Envelope; der Wert error.type spiegelt den HTTP-Status, sodass die Fehlerbehandlung Ihres SDK unverändert weiterarbeitet.

CodeWann
400 invalid_request_errorFehlerhafter Request-Body oder Parameter.
400 invalid_request_errorModell-ID ohne Provider-Präfix. Jede aufrufbare ID ist provider/model, z. B. mistral/mistral-large-latest; der Body meldet: model must be provider-prefixed.
400 invalid_request_errorDie Anfrage trägt den entfernten x-sluis-dlp-Header. Overrides pro Anfrage wurden durch Option-Overrides pro Key ersetzt; konfigurieren Sie sie unter Console → API keys.
401 authentication_errorFehlender oder unbekannter API-Key.
402 insufficient_quotaKein aktiver Plan oder Budget erreicht. Aktivieren Sie einen Plan oder erhöhen Sie das Budget; die Anfrage erreicht nie einen Anbieter.
403 permission_errorDem Key fehlt die Berechtigung, etwa weil das Modell nicht auf seiner Allow-List steht.
422 invalid_request_errorVor dem Versand abgewiesen, etwa weil der Datenschutz im block-Modus die Anfrage erfasst hat.
422 document_too_large_to_scanEine Dokumentseite bleibt selbst bei der minimalen Scan-Auflösung über der Render-Pixelgrenze. Großformatige Seiten (A0/A1-Zeichnungen) werden automatisch herunterskaliert gerendert; der dedizierte Code erlaubt dem Client, die Seite zu verkleinern und erneut einzureichen.
429 rate_limit_errorRate-Limit erreicht. Am Gateway durchgesetzt; die Anfrage erreicht nie einen Anbieter.
451 permission_errorDurch die Residency-Policy blockiert: keine erlaubte Jurisdiktion bedient die Anfrage. Der Body enthält den Grund.
5xx api_errorAusfall des Upstream-Anbieters nach Wiederholungsversuchen; der Circuit Breaker lenkt den Traffic an fehlerhaften Anbietern vorbei.
{
  "error": {
    "message": "model must be provider-prefixed, e.g. mistral/mistral-large-latest",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_request"
  }
}