Zum Hauptinhalt springen
Die Public API von Omnifact ermöglicht Entwicklerteams, die KI-Funktionen von Omnifact nahtlos in eigene Anwendungen, interne Portale und automatisierte Workflows einzubinden. Sie können Dokumente in den Hochgeladenen Dateien eines Space verwalten, OpenAI-kompatible Modellanfragen über das AI Gateway ausführen und direkt mit veröffentlichten interagieren.

Interaktive OpenAPI-Dokumentation

Unter connect.omnifact.ai/docs finden Sie unsere interaktive Swagger- bzw. OpenAPI-Spezifikation für Live-Endpunkttests und vollständige Schemadefinitionen.

Basis-URL

Alle Anfragen an die Public API und das AI Gateway richten sich an folgende Basis-URL:
JSON-Anfrage-Bodys haben über alle Endpunkte der Public API hinweg ein Größenlimit von 1 MB.

Authentifizierung

Die Authentifizierung hängt davon ab, welchen API-Bereich Sie aufrufen:

1. Organisations-Endpunkte (/v1/documents/* und /v1/gateway/*)

Anfragen an die Dokumente-API und das AI Gateway erfordern den API-Schlüssel Ihrer Organisation. Sie können ihn wahlweise im Header X-API-Key oder im Standard-Header Authorization: Bearer übergeben:
Bewahren Sie Ihren API-Schlüssel sicher auf. Legen Sie den Organisations-API-Schlüssel niemals in clientseitigem Browser-Code, mobilen Apps oder öffentlichen Repositories offen.

2. Chat-Endpunkte für veröffentlichte Spaces (/v1/endpoints/{endpointId}/chat)

POST /v1/endpoints/{endpointId}/chat verwendet keinen X-API-Key. Stattdessen dient die {endpointId}-UUID in der Endpunkt-URL selbst als geheimer Berechtigungs-Token (Capability URL). Behandeln Sie die vollständige Endpunkt-URL wie ein Passwort und leiten Sie Anfragen über Ihr Backend weiter, wenn Sie ein Chat-Widget extern einbinden.

3. Health-Check (GET /)

GET https://connect.omnifact.ai/ ist ein unauthentifizierter Health-Check-Endpunkt, der eine Klartext-Bestätigung zurückgibt.
Hinweis zum Privacy Filter: Programmgesteuerte Anfragen an connect.omnifact.ai (einschließlich Dokumente-API, Veröffentlichte Spaces Chat-API und AI Gateway) durchlaufen nicht den Omnifact Privacy Filter. Stellen Sie sicher, dass Ihre Integration sensible Daten gemäß Ihren internen Datenschutzrichtlinien behandelt.

API-Schlüssel erstellen und rotieren

Administratoren im Enterprise-Plan verwalten den API-Schlüssel direkt in Omnifact:
  1. Klicken Sie unten links in der Hauptnavigation auf Ihr Organisationslogo (oberhalb Ihres Benutzer-Avatars) und wählen Sie Team-Einstellungen.
  2. Öffnen Sie in der Seitenleiste Entwickler-Tools.
  3. Aktivieren Sie den Schalter API-Zugriff aktivieren. Omnifact erstellt sofort Ihren Schlüssel und öffnet den Dialog Ihr neuer API-Schlüssel, in dem Sie den Schlüssel kopieren und sicher hinterlegen können.
  4. Um einen bestehenden Schlüssel jederzeit auszutauschen, klicken Sie neben Aktueller API-Schlüssel auf Neu generieren.
Weitere Informationen finden Sie unter Entwickler-Tools.

Verfügbare API-Bereiche

Omnifact stellt unter https://connect.omnifact.ai drei API-Bereiche bereit:

Dokumente-API

Dokumente in den Hochgeladenen Dateien eines Space programmgesteuert auflisten, hochladen, abrufen, umbenennen und löschen.

Veröffentlichte Spaces Chat-API

Nachrichten an veröffentlichte Space-Endpunkte senden, wahlweise mit JSON-Antworten oder Echtzeit-SSE-Streaming.

AI Gateway

Aktivierte KI-Modelle verschiedener Anbieter über eine einheitliche, OpenAI-kompatible /v1/gateway-Schnittstelle aufrufen.

Fehlerbehandlung

Die API nutzt standardmäßige HTTP-Statuscodes:

Fehlerantwort-Formate

Je nach Endpunkt-Familie verwendet Omnifact zwei unterschiedliche Fehlerstrukturen:
Fachliche Fehler unter /v1/documents/* und /v1/endpoints/* liefern ein flaches JSON-Objekt mit einem kleingeschriebenen snake_case-code, einer message und optionalen details:
Authentifizierungs-, Autorisierungs- und 404-Fehler liefern das Standard-HTTP-Fehlerformat:

Nächste Schritte