Basis-Pfad & Authentifizierung
Alle/v1/documents/*-Endpunkte erfordern Ihren Organisations-API-Schlüssel im Header X-API-Key oder Authorization: Bearer:
Nur manuelle & API-Uploads: Die Dokumente-API gibt ausschließlich manuell oder per API hochgeladene Dokumente zurück. Dateien, die über Verbundene Quellen (SharePoint, OneDrive, Google Drive) synchronisiert werden, sind nicht über
/v1/documents abrufbar oder bearbeitbar (Abfragen per ID liefern 404 Not Found).Das Document-Objekt
Alle Endpunkte, die ein Dokument zurückgeben (GET, POST, PATCH), verwenden folgendes Schema:
Health-Check Ping
GET /
Prüft ohne Authentifizierung, ob der Dienst der Omnifact Public API erreichbar ist.
Beispielanfrage
Antwort (200 OK, text/plain)
Unterstützte Dateitypen auflisten
GET /v1/documents/supported-file-types
Gibt ein JSON-Array aller 17 unterstützten MIME-Typen und Dateiendungen (ohne führenden Punkt) für Hochgeladene Dateien zurück.
Tabellenkalkulationen (
.xls, .xlsx, .ods) und Rasterbilder (.png, .jpg, .webp usw.) werden in Space-Wissen bewusst nicht unterstützt. Hängen Sie Tabellen oder Bilder stattdessen direkt im Chat an.Beispielanfrage
Antwort (200 OK)
Dokumente auflisten
GET /v1/documents
Listet manuell und per API hochgeladene Dokumente eines Space auf, absteigend sortiert nach contentUpdatedAt (neueste zuerst).
Abfrageparameter
Beispielanfrage
Antwort (200 OK)
Dokument hochladen
POST /v1/documents
Lädt ein neues Dokument in die Hochgeladenen Dateien eines Space hoch. Die Indexierung erfolgt asynchron: Omnifact extrahiert den Text pro Seite bzw. Folie, führt die Entitätserkennung des Privacy Filters aus, erzeugt durchsuchbare Textabschnitte sowie Vektor-Embeddings und setzt status anschließend von "processing" auf "ready" (oder "error").
Abfrageparameter
Optionale Header
Anfrage-Body (multipart/form-data)
Beispielanfrage
Antwort (201 Created)
Dokumentdetails abrufen
GET /v1/documents/{id}
Ruft Metadaten, Zeitstempel und Indexierungsstatus eines einzelnen Dokuments ab.
Pfadparameter
Beispielanfrage
Antwort (200 OK)
Dokument aktualisieren
PATCH /v1/documents/{id}
Aktualisiert den Anzeigenamen oder die Metadaten eines Dokuments (maximale JSON-Body-Größe: 1 MB).
Pfadparameter
Anfrage-Body (application/json)
Beispielanfrage
Antwort (200 OK)
Dokument löschen
DELETE /v1/documents/{id}
Löscht die gespeicherte Datei dauerhaft aus dem Objektspeicher, entfernt alle extrahierten Textteile, Chunks und Vektor-Embeddings aus der Datenbank und aktualisiert die Space-Zusammenfassung.
Beispielanfrage
Antwort (204 No Content)
Gibt einen leeren Body mit Statuscode 204 No Content zurück.
Fehlercodes
Schlägt die Validierung beiPOST /v1/documents oder PATCH /v1/documents/{id} fehl, antwortet die API mit 400 Bad Request (bzw. 403 Forbidden) und einem strukturierten Fehlercode:
Nächste Schritte
- Fragen Sie veröffentlichte Space-Agenten über die Veröffentlichte Spaces Chat-API ab
- Prüfen Sie unterstützte Formate und Seitenkontingente unter Hochgeladene Dateien verwalten