Suche und Antworten – search liefert die Passagen, die zu einer Frage passen, mit Seiten und einem Link zum Original; ask liefert eine kurze Antwort.
Auf dieser SeiteRessourcen für KI
- Ressourcen für KI
- Das Token eines angemeldeten Nutzers
- Was die API abdeckt
- Die Form einer Anfrage
- Endpunkte
- Dokumente importieren
- POST /ingest
- GET /jobs/{job_id}
- Suchen und Fragen
- POST /search
- POST /ask
- Ordner und ihr Inhalt
- GET /folders/summary
- GET /folders
- GET /folders/{id}
- GET /documents
- Dokumente lesen
- GET /documents/{id}
- POST /documents/batch
- GET /documents/{id}/content
- GET /documents/{id}/tags
- Wenn ein Aufruf fehlschlägt
- Sie möchten frühen Zugang zur API?
API-Referenz
Jeder öffentliche Endpunkt an einem Ort
Die Endpunkte, die die Hippocampus-Web-App für Import, Suche, Antworten und Lesen nutzt, mit ihren Feldern, Streaming, Jobs und Fehlern.
Ressourcen für KI
Coding-Agent
Ihr Coding-Agent (Claude, Cursor, Codex oder ein anderer) liest unsere Skill-Datei und richtet Hippocampus selbstständig in Ihrem Projekt ein.
API-Clients
Ihr API-Client (Postman, Insomnia oder Bruno) importiert jede Anfrage mit Beispielantworten; führen Sie zuerst Sign in aus, und das Token wird für Sie gesetzt.
OpenAPI 3.1
Client-Generatoren, Swagger UI und andere API-Tools lesen jeden Endpunkt aus dieser Datei, im Standardformat.
Chat-Assistenten
Ihr Chat-Assistent (ChatGPT, Claude oder Gemini) beantwortet Fragen zur API aus unserer Doku, alles in einer Datei.
Authentifizierung
Das Token eines angemeldeten Nutzers
Jede Anfrage trägt einen Authorization: Bearer <token>-Header. Das Token ist das ID-Token eines angemeldeten Hippocampus-Nutzers und gilt etwa eine Stunde; ein Skript erneuert es also so, wie es jede Anmeldung tut. Ein Aufruf erreicht nur, was dieser Nutzer lesen darf.
Es gibt keine API-Schlüssel: Heute verbinden Sie sich über MCP, das Sie im Browser anmeldet (siehe MCP-Seite). Solange die REST-API im Early Access ist, meldet sich ein Skript als eigener Nutzer an, dem die benötigten Ordner freigegeben sind.
Der Umfang
Was die API abdeckt
Dokumente – eine Quelle importieren und verfolgen, wie sie in Abschnitte zerlegt wurde.
Durchsuchen und Lesen – Ordner auflisten, den Text eines Dokuments lesen oder das Original herunterladen.
Jobs – den Status eines Imports prüfen.
Fehler – die Form eines Fehlers aus jedem Dienst.
Beispielhaft
Die Form einer Anfrage
Ein importiertes Dokument und eine Frage, beantwortet aus dem Importierten. Endpunkte und Felder sind nicht endgültig.
curl -X POST /ingest \
-H "Authorization: Bearer $HIPPOCAMPUS_TOKEN" \
-F "[email protected]" client.documents.create(
file="q3-renewals.pdf",
) await client.documents.create({
file: "q3-renewals.pdf",
}); Nur zur Veranschaulichung – noch keine verbindliche Spezifikation.
Referenz
Endpunkte
Die API hat zwei Dienste, und beide nehmen dasselbe Token. Der Core importiert, sucht und antwortet; der Vault hält Ordner und Dokumente. Welcher Core und welcher Vault Ihren Workspace bedienen, hängt von seinem Release-Kanal ab. Die Beispiele unten verwenden https://hippocampuscore.thalius.ai für den Core und https://hippocampusvault.thalius.ai für den Vault; antwortet ein Aufruf mit 409 und code: wrong_channel, wird Ihr Workspace von einem anderen Kanal bedient, und core_url in der Antwort nennt den Core, an den Sie ihn senden.
Jeder Endpunkt unten hat eine Anfrage in cURL, Python und JavaScript sowie eine gekürzte Antwort.
Import
Dokumente importieren
Laden Sie Dateien in den Core hoch. Jede Datei wird gelesen, in Abschnitte zerlegt und zusammengefasst, dann im Ordner abgelegt, den Sie angeben. Ein Job verfolgt die Arbeit.
Core
POST /ingest
Core
GET /jobs/{job_id}
Suche und Antworten
Suchen und Fragen
Search liefert die Passagen, die zu einer Frage passen, jede mit ihren Seiten und einem Link zum Original. Ask liefert eine kurze, vom Modell geschriebene Antwort.
Core
POST /search
Core
POST /ask
Durchsuchen
Ordner und ihr Inhalt
Ordnerzusammenfassungen kommen aus dem Core; Ordner und Dokumentlisten kommen aus dem Vault.
Core
GET /folders/summary
Vault
GET /folders
Vault
GET /folders/{id}
Vault
GET /documents
Lesen
Dokumente lesen
Der Vault liefert den Text eines Dokuments, seine Tags und die Originaldatei.
Vault
GET /documents/{id}
Vault
POST /documents/batch
Vault
GET /documents/{id}/content
Fehler
Wenn ein Aufruf fehlschlägt
Clients
Derzeit
curl und unser MCP-Server funktionieren heute schon. Offizielle SDKs für Python und TypeScript sind vor der allgemeinen Verfügbarkeit geplant.
Sie möchten frühen Zugang zur API?
Wir nehmen jetzt Design-Partner auf.