Zum Hauptinhalt springen

Was ist das API Gateway?

Das Omnifact API Gateway bietet eine einheitliche API, um über einen einzigen Endpunkt auf Modelle führender KI-Anbieter zuzugreifen. Es ermöglicht Ihren Entwicklern und internen Anwendungen, Anfragen direkt an leistungsstarke KI-Modelle weiterzuleiten, ohne dass Sie separate Konten bei verschiedenen KI-Anbietern einrichten müssen. Zu den wichtigsten Vorteilen gehören:
  • Ein Schlüssel, mehrere Anbieter: Greifen Sie mit einem einzigen API-Schlüssel auf Modelle von OpenAI, Anthropic, Google, Mistral AI und Weiteren zu.
  • Nahtloser Austausch: Wechseln Sie mit minimalen Codeänderungen zwischen Anbietern und Modellen, indem Sie bestehende OpenAI-kompatible SDKs verwenden.
  • Zentrale Abrechnung & Übersicht: Überwachen Sie Ihre Ausgaben und Nutzung über alle Anbieter hinweg an einem Ort. Sie benötigen keine Kreditkarten für separate Anbieter.
  • Nutzung Ihres bestehenden Budgets: Der Verbrauch wird über das bestehende KI-Budget Ihrer Organisation abgerechnet und läuft über Ihren Omnifact-Vertrag.

Erste Schritte

Das API Gateway steht exklusiv Kunden im Enterprise-Plan zur Verfügung. Besuchen Sie unsere Abrechnung-Seite oder kontaktieren Sie den Support, um ein Upgrade durchzuführen.
Um das API Gateway zu nutzen, müssen Sie den API-Zugriff aktivieren und einen API-Schlüssel generieren.
  1. Voraussetzungen: Stellen Sie sicher, dass der Zugriff auf das API Gateway für Ihre Organisation durch Omnifact aktiviert wurde. (Hinweis: Wenn diese Funktion für Ihre Organisation nicht aktiviert ist, geben alle Anfragen an die API den Fehler 403 Forbidden zurück.)
  2. Aktivierung: Ein Administrator muss das Gateway im Bereich Entwicklertools aktivieren.
  3. Authentifizierung: Alle Anfragen an das API Gateway müssen Ihren API-Schlüssel (den Sie unter Team-Einstellungen > Entwicklertools generieren können) im x-api-key-Header (oder als Bearer-Token bei Verwendung von OpenAI-SDKs) enthalten.
Für die vollständigen API-Spezifikationen lesen Sie bitte die Live-OpenAPI-Dokumentation.

Verfügbare Modelle

Sie können die verfügbaren Modelle über den standardmäßigen OpenAI-Modell-Endpunkt abfragen. Detaillierte Spezifikationen zu den Endpunkt-Parametern und Antwortformaten finden Sie in der OpenAI API-Referenz.

GET /v1/gateway/models

curl https://connect.omnifact.ai/v1/gateway/models \
  -H "Authorization: Bearer YOUR_API_KEY"
Beispielantwort:
{
  "object": "list",
  "data": [
    {
      "id": "gpt-4o",
      "object": "model",
      "created": 1715368132,
      "owned_by": "openai"
    },
    {
      "id": "claude-4-sonnet",
      "object": "model",
      "created": 1718841600,
      "owned_by": "anthropic"
    }
  ]
}

EU-gehostete Modelle

Das API Gateway unterstützt die gezielte Weiterleitung von Anfragen an EU-gehostete Anbieter.
  • Der Endpunkt /v1/gateway/models kann sowohl Standard-Modell-IDs (z. B. gpt-4o) als auch EU-spezifische Modell-IDs (z. B. eu/gpt-4o) zurückgeben.
  • Um die Weiterleitung an ein EU-Backend zu erzwingen, stellen Sie der Modell-ID in Ihrer Anfrage eu/ voran. Standard-Modell-IDs werden nur an Nicht-EU-Backends weitergeleitet.

Chat Completions

Das API Gateway bietet nahtlos kompatible APIs, mit denen Sie Anbieter wechseln können, indem Sie einfach Ihre Basis-URL in https://connect.omnifact.ai/v1/gateway ändern. Es sind keine Code-Umschreibungen erforderlich. Sie können dieselben SDKs und Tools verwenden, die Sie bereits kennen.

POST /v1/gateway/chat/completions

Dieser Endpunkt akzeptiert das standardmäßige OpenAI-kompatible Format und unterstützt Streaming, Routing, benutzerdefinierte Temperaturen und mehr. (Hinweis: Tool Calling und Structured Outputs werden in V1 nicht unterstützt).
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://connect.omnifact.ai/v1/gateway',
  apiKey: 'YOUR_API_KEY', // typically process.env.OMNIFACT_API_KEY
});

async function main() {
  const response = await client.chat.completions.create({
    model: 'gpt-4o',
    messages: [{ role: 'user', content: 'Hello, how are you?' }],
    stream: true,
  });

  for await (const chunk of response) {
    process.stdout.write(chunk.choices[0]?.delta?.content || '');
  }
}

main();

Anfrage- und Antwortbeschränkungen

Obwohl das API Gateway OpenAI-kompatibel ist, gelten folgende Einschränkungen:
  • Nachrichten: Die letzte Nachricht im Array muss die Rolle user haben. Die Rollen system oder developer sind nur am Anfang des Nachrichten-Arrays zulässig. Die Rolle developer wird unterstützt.
  • Inhalt: Der Nachrichteninhalt kann ein String oder ein Array von { type: "text", text: "..." } Objekten sein (Arrays werden abgeflacht).
  • Limits: Maximal 1024 Nachrichten pro Anfrage und bis zu 200.000 Zeichen pro Nachricht.
  • Parameter: Unterstützte Parameter umfassen temperature (0–2, skaliert je nach Anbieter; einige Modelle können dies ablehnen), max_completion_tokens (oder max_tokens), stream und stream_options.include_usage.
  • Antwort-Modell-Feld: Die Antwort gibt den kanonischen Modelltyp zurück, der nicht zwingend mit der angeforderten ID übereinstimmen muss (z. B. wenn Sie ein Modell mit eu/...-Präfix oder einen Alias angefordert haben).

Nutzung & Abrechnung

Die Nutzung des API Gateways verbraucht das monatliche KI-Budget Ihrer Organisation. Das bedeutet, dass Sie keine separate Abrechnung für die API-Nutzung verwalten müssen. Bitte beachten Sie, dass die Nutzung des API Gateways einen Aufschlag auf die Basis-Modellkosten beinhaltet.
Strikte Durchsetzung des Guthabens: Im Gegensatz zur Chat-Benutzeroberfläche (die auf Basis-Modelle zurückgreift, wenn das Guthaben aufgebraucht ist) setzt das API Gateway die Guthabenlimits strikt durch. Wenn das Guthaben Ihrer Organisation aufgebraucht ist, werden alle API-Anfragen blockiert, bis neues Guthaben hinzugefügt wird oder der Abrechnungszyklus zurückgesetzt wird. Basis-Modelle stehen nicht als Fallback zur Verfügung, wenn das Guthaben aufgebraucht ist.
Sie können Ihre gesamte Nutzung und den Guthabenverbrauch im Dashboard Abrechnung & Nutzung überwachen.

Fehlercodes

Zusätzlich zu den Standard-HTTP-Fehlern kann das API Gateway die folgenden Statuscodes zurückgeben:
  • 401 Unauthorized: Fehlender oder ungültiger API-Schlüssel.
  • 402 Payment Required: Kein aktives Abonnement (subscription_required) oder Guthaben aufgebraucht (insufficient_quota). Ein aktives Abonnement wird bei jeder Chat Completion-Anfrage validiert.
  • 403 Forbidden: Der API Gateway-Zugriff ist für Ihre Organisation nicht aktiviert.
  • 404 Not Found: Das angeforderte Modell wurde nicht gefunden oder ist deaktiviert.
  • 429 Too Many Requests: Ratenlimit des Upstream-Anbieters erreicht.

FAQ

Noch nicht. Die Integration des Privacy Filters für das API Gateway ist für ein zukünftiges Update geplant.
Die verfügbaren Modelle hängen vom spezifischen Omnifact-Plan und der Konfiguration Ihrer Organisation ab. Sie können den Endpunkt /v1/gateway/models verwenden, um die genaue Liste der für Sie verfügbaren Modelle einzusehen. Basis-Modelle sind verfügbar, solange Sie über Guthaben verfügen, können jedoch nicht als Fallback verwendet werden, wenn das Guthaben aufgebraucht ist.
Derzeit gibt es nur einen API-Schlüssel pro Organisation, der über den Bereich Entwicklertools verwaltet wird.