API-Dokumentation¶
Sie können APIs entweder mit OAuth2 oder API-Schlüsseln authentifizieren. OAuth2 ist ein standardisiertes Autorisierungsframework, das es Anwendungen ermöglicht, sicher auf bestimmte Dokumente innerhalb eines Systems zuzugreifen. API-Schlüssel bieten hingegen eine einfachere Methode, um Dokumente aus einer gemeinsamen Wissensdatenbank abzurufen, ohne den OAuth2-Authentifizierungsprozess durchlaufen zu müssen.
API-Übersicht¶
Rememberizer bietet eine umfassende Sammlung von APIs zum Arbeiten mit Dokumenten, Vektor-Speichern, Mementos und mehr. Die APIs sind in die folgenden Kategorien organisiert:
Authentifizierungs-APIs¶
- Registrierung, Anmeldung, E-Mail-Verifizierung
- Passwort zurücksetzen
- OAuth-Endpunkte (Google, Microsoft)
- Token-Verwaltung und Abmeldung
Benutzer-APIs¶
- Benutzerprofil und Kontoinformationen
- Benutzer-Onboarding
Dokumenten-APIs¶
- Auflisten, Erstellen und Aktualisieren von Dokumenten
- Dokumentenverarbeitung
- Batch-Dokumentoperationen
Such-APIs¶
- Grundlegende Suche
- Agentische Suche
- Batch-Suchoperationen
Mementos APIs¶
- Erstellen, Auflisten, Aktualisieren und Löschen von Mementos
- Verwalten von Memento-Dokumenten
Vektor-Speicher-APIs¶
- Erstellen und Auflisten von Vektor-Speichern
- Hochladen von Text- und Dateidokumenten
- Durchsuchen von Vektor-Speichern
- Batch-Hochladen und -Durchsuchen
Integrationen APIs¶
- Integrationen auflisten
- OAuth-Integrationsendpunkte (Google Drive, Gmail, Slack, Dropbox)
Anwendungen APIs¶
- Anwendungen auflisten und erstellen
Gemeinsame Wissens-APIs¶
- Auflisten und Erstellen von gemeinsamen Wissensobjekten
Team-APIs¶
- Teamverwaltung
- Teammitglieder
- Rollenbasierte Berechtigungen
Für Unternehmensintegrationsmuster, Sicherheitsüberlegungen und architektonische Best Practices siehe den Leitfaden Enterprise Integration Patterns.
Basis-URL¶
Alle API-Endpunkte sind relativ zu:
Authentifizierung¶
Endpunkte erfordern eine Authentifizierung entweder über: - JWT-Token (im Authorization-Header oder in Cookies übergeben) - API-Schlüssel (im x-api-key-Header übergeben)
Für detaillierte Informationen zu spezifischen Endpunkten siehe die einzelnen API-Dokumentationsseiten.