API-Übersicht & Authentifizierung

Die öffentliche API von Omnifact ermöglicht es Entwicklern und Teams, die KI-Funktionen von Omnifact in externe Anwendungen, benutzerdefinierte Portale und automatisierte Workflows zu integrieren. Sie können Dokumente in den Hochgeladenen Dateien eines Space verwalten, den Systemstatus abfragen und direkt mit veröffentlichten kommunizieren.

Interaktive OpenAPI-Dokumentation

Greifen Sie unter connect.omnifact.ai/docs auf die interaktive Swagger / OpenAPI-Spezifikation für Live-Endpunkttests und vollständige Schemadefinitionen zu.

Authentifizierung

Alle Anfragen an die öffentliche API von Omnifact erfordern eine Authentifizierung über einen API-Schlüssel, der im HTTP-Header X-API-Key übergeben wird.

X-API-Key: ihr_omnifact_api_schluessel_hier

Bewahren Sie Ihren API-Schlüssel sicher auf. Geben Sie Ihren API-Schlüssel nicht in clientseitigem Code, öffentlichen Repositories oder Frontend-Webanwendungen preis.

API-Schlüssel verwalten

Team-Administratoren können Organisations-API-Schlüssel direkt aus der Omnifact-Anwendung heraus generieren und verwalten:

Navigieren Sie in der Hauptnavigationsleiste zu den Teameinstellungen.
Klicken Sie auf Entwickler-Tools (erfordert Administratorrechte).
Aktivieren Sie den API-Zugriff, falls er nicht bereits aktiv ist.
Klicken Sie auf API-Schlüssel generieren, um einen Schlüssel für Ihr Team zu erstellen.

Schritt-für-Schritt-Anleitungen zum Aktivieren des Entwicklerzugriffs finden Sie unter Entwickler-Tools.

Basis-URL

Alle Anfragen an die öffentliche API sollten an die folgende Basis-URL gesendet werden:

https://connect.omnifact.ai

Verfügbare API-Ressourcen

Die öffentliche API ist in zwei primäre Funktionsbereiche unterteilt:

Dokumente-API

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

Veröffentlichte Spaces Chat-API

Nachrichten an veröffentlichte Space-Endpunkte senden, mit Unterstützung für JSON und Echtzeit-SSE-Streaming.

Fehlerbehandlung

Die API verwendet standardmäßige HTTP-Statuscodes zur Anzeige von Anfrageresultaten:

Statuscode	Bedeutung	Beschreibung
`200 OK`	Erfolg	Anfrage erfolgreich.
`201 Created`	Erstellt	Ressource erfolgreich erstellt (z. B. Dokument-Upload).
`400 Bad Request`	Ungültige Anfrage	Fehlende oder ungültige Parameter.
`401 Unauthorized`	Nicht autorisiert	Fehlender oder ungültiger `X-API-Key`-Header.
`404 Not Found`	Nicht gefunden	Angefordertes Dokument oder Endpunkt-ID existiert nicht.
`429 Too Many Requests`	Ratenlimit überschritten	Kontingent oder Ratenlimit überschritten.
`500 Internal Error`	Serverfehler	Bei der Verarbeitung der Anfrage ist ein interner Fehler aufgetreten.

Alle Fehlerantworten geben ein JSON-Objekt mit Fehlerdetails zurück:

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Der angegebene Header X-API-Key ist ungültig oder abgelaufen."
  }
}

Nächste Schritte

Erkunden Sie die Dokumente-API für die Dokumentenverwaltung
Erfahren Sie, wie Sie Chat-Antworten mit der Veröffentlichten Spaces Chat-API streamen
Konfigurieren Sie API-Einstellungen unter Entwickler-Tools

Interaktive OpenAPI-Dokumentation

​Authentifizierung

​API-Schlüssel verwalten

​Basis-URL

​Verfügbare API-Ressourcen

Dokumente-API

Veröffentlichte Spaces Chat-API

​Fehlerbehandlung

​Nächste Schritte

Authentifizierung

API-Schlüssel verwalten

Basis-URL

Verfügbare API-Ressourcen

Fehlerbehandlung

Nächste Schritte