Dokumentation
AACSearch stellt verwaltete Suche über eine mandantengebundene API bereit. Erstellen Sie Indizes, laden Sie Dokumente hoch und suchen Sie über Konsole, REST-API oder SDK. Die Plattform prüft Zugriffsrechte, Kontingente und Analysen.
AACSearch stellt verwaltete Suche über eine mandantengebundene API bereit. Erstellen Sie Indizes, laden Sie Dokumente hoch und suchen Sie über Konsole, REST-API oder SDK. Die Plattform prüft Zugriffsrechte, Kontingente und Analysen.
Jeder hier beschriebene Endpunkt wird von der laufenden Instanz unter /api/v1 bedient; alle gezeigten Request- und Response-Bodies entsprechen dem Quellcode in packages/api/routes/v1.
Einstieg
Plattformüberblick
Wie Mandanten, Engine und API zusammenspielen.
Schnellstart
Index anlegen, Dokumente laden, erste Suche ausführen.
API-Referenz
Authentifizierung, Endpunkte, Request- und Response-Bodies.
Fehler & Limits
Fehlercodes, Rate-Limits, Tarifkontingente und Wallet-Verhalten.
Was die Plattform leistet
- Mandantenisolation. Der Indexzugriff wird innerhalb der Organisation des Schlüssels geprüft. Mandanten- und Dokumentfilter werden serverseitig angewendet.
- Öffentliche API mit Schlüsseln. Schlüssel sehen aus wie
aac_live_…, tragen Scopes und werden als SHA-256-Hash gespeichert — der Klartext erscheint genau einmal. - Suche, die mehr kann als Wortabgleich. Tippfehlertoleranz, Facetten, Gruppierung, Filter, Vektor- und hybride semantische Suche, Autocomplete, Klick- und Conversion-Tracking.
- KI-Funktionen auf demselben Index. RAG-Antworten mit Quellenangaben, ein Dialog-Assistent mit Streaming, natürlichsprachige Suche, Sprach- und Bildanfragen.
- Nachvollziehbare Abrechnung. Suchen, Dokumente, KI-Token und Reindex-Läufe werden pro Abrechnungsperiode gezählt;
GET /billing/usageundGET /billing/walletzeigen genau die Zahlen, die die API durchsetzt. - Ein Widget, das keinen Schlüssel im Browser braucht. Ihr Server tauscht den API-Schlüssel gegen ein kurzlebiges, reines Such-Session-Token (
POST /api/v1/embed/session); das Embed-Skript nutzt nur dieses Token über den AACSearch-Proxy.
Aufbau dieser Dokumentation
| Abschnitt | Inhalt |
|---|---|
| Erste Schritte | Plattformüberblick und ein Schnellstart in fünf Schritten |
| API-Referenz | Auth, Suche, Suggest, Dokumente, Analytics, Embed-Session, Status, Webhooks, Fehler |
| SDKs | Typisierte Clients für TypeScript und Python |
| Anleitungen | Semantische Suche, RAG-Assistent, Sprache und Bilder, Experimente, Connectoren, Abrechnung, Widget |
Versionen und Kompatibilität
Die API ist im Pfad versioniert (/api/v1). Antworten sind JSON mit snake_case-Schlüsseln; Fehler nutzen immer den Umschlag {"error": {"code", "message", "request_id"}}. Jede Antwort enthält eine request_id, die Sie im Supportfall angeben sollten.
GET /api/v1/capabilities nennt die unterstützten Funktionen. Eine Funktion kann zusätzlich ein konfiguriertes Modell, Indexfelder oder Betriebseinstellungen benötigen. Backend-Version und Infrastrukturdetails gehören zur Plattformadministration.