⌨️API-Übersicht - amber

Wichtigste Funktionen

• Authentifizierung: API-Schlüssel (empfohlen) und OAuth 2.0 Authorization Code Grant für Apps von Drittanbietern. Basis-URL: https://customerDomain.ambersearch.de/api/beta.

• Such-Endpunkte: Endpunkte für die Volltextsuche und die Websuche zum Abfragen Ihrer indizierten Inhalte. Verwenden Sie die Endpunkte GET /search und POST /websearch.

• Dokumentenverwaltung: Abrufen von Dokumentmetadaten, Herunterladen von Dokumenten und Hochladen von Dateien über GET/POST-Endpunkte (z. B. GET für Dokumentmetadaten, POST für Datei-Upload).

• OpenAI-ähnliche KI-Endpunkte: Listen Sie verfügbare Modelle auf, rufen Sie Modelldetails ab und erstellen Sie Chat-Vervollständigungen (POST /api/beta/amberai/chat/completions) einschließlich Parametern für Modell, Temperatur, Streaming, Tools und Nachrichten. Beispiel-cURL-Befehle und Code-Schnipsel sind verfügbar.

• AmberSearch MCP-Server: Bietet Serverintegrationen und zusätzliche Funktionen für fortgeschrittene Anwendungen (siehe Dokumentation).

Schnellstart

1. Erstellen Sie einen API-Schlüssel in der Amber-Benutzeroberfläche.

   https://helpcenter.ambersearch.de/de/articles/1136690-wie-sie-ihren-api-schlussel-erhalten

2. Rufen Sie den Such-Endpunkt auf: curl -X GET "https://customerDomain.ambersearch.de/api/beta/search?query=example" -H "Authorization: Bearer YOUR_API_KEY".

3. Für die Nutzung von AI/Chat listen Sie die Modelle auf und rufen Sie dann „chat/completions“ mit Nachrichten und der Modell-ID auf.

Hinweise & Einschränkungen

• Die API befindet sich in der Beta-Phase und wird aktiv weiterentwickelt; Endpunkte können sich ändern.

• Es gelten Ratenbeschränkungen, die an Ihren API-Schlüssel gebunden sind.

Ausführliche Informationen, Beispiele und aktuelle Referenzinformationen finden Sie in der vollständigen Dokumentation unter https://developers.ambersearch.de