API-Nutzung

Warnung

Dieser Dienst befindet sich derzeit in der Beta-Phase und wird regelmäßig aktualisiert.
Das gilt auch für die Dokumentation.

Der Arcana-Manager stellt einen API-Endpunkt zur Verfügung, den Sie nutzen können.
Mit diesem Endpunkt können Sie alle Aktionen durchführen, die die Frontend-Oberfläche des Arcana-Managers unterstützt.

Um die API zu nutzen, benötigen Sie zunächst einen API-Schlüssel, den Sie auf unserer Website beantragen können. Dieser Schlüssel funktioniert über alle unsere Dienste hinweg. Wenn Sie bereits die LLMs über die API nutzen, können Sie denselben Schlüssel verwenden.
Andernfalls können Sie Ihren Schlüssel gemäß der Anleitung beantragen.

Info

Wenn Sie mit einer Arcana über die LLM-Chat-Vervollständigungs-API chatten möchten, verweisen wir auf diesen Abschnitt in der SAIA-Dokumentation.

Basis-Route

Alle Routen für die RAG/Arcana-API beginnen mit
https://chat-ai.academiccloud.de/v1/arcanas/api/v1/

Beachten Sie, dass jeder API-Aufruf mit https://chat-ai.academiccloud.de/v1/ beginnen muss. Routen, die mit https://chat-ai.academiccloud.de/arcanas/ beginnen, sind nicht mit API-Schlüsseln kompatibel.

Weitere Informationen finden Sie unten.

Minimalbeispiel für die API

Hier finden Sie ein funktionierendes Minimalbeispiel zur Nutzung der API.

​
curl \
  --url https://chat-ai.academiccloud.de/v1/arcanas/api/v1/ \
  --header 'Accept: application/json' \
  --header 'Authorization: <api_key>'
​
{
    "message": "Willkommen beim SAIA RAG Web-API",
    "docs_url": "http://chat-ai.academiccloud.de/arcanas/api/v1/docs"
}

Beispiele und API-Dokumentation

Alle Ihre Arcanas abrufen

curl \
  --url https://chat-ai.academiccloud.de/v1/arcanas/api/v1/arcana/ \
  --header 'Accept: application/json' \
  --header 'Authorization: <api_key>'

Eine bestimmte Arcana abrufen

curl \
  --url https://chat-ai.academiccloud.de/v1/arcanas/api/v1/arcana/<arcana-name> \
  --header 'Accept: application/json' \
  --header 'Authorization: <api_key>'

Eine neue Datei Ihrer Arcana hinzufügen

Jede neue Datei muss in einer eigenen Anfrage übermittelt werden.

curl -i -X POST "https://chat-ai.academiccloud.de/v1/arcanas/api/v1/arcana/<arcana-name>/files/" \
    -H "accept: application/json" \
    -H 'Authorization: <api_key>' \
    -H "Content-Type: multipart/form-data" \
    -F "file=@<dateiname>"

Die Antwort ist null mit einem Statuscode von 200, falls der Upload erfolgreich war.

Eine Arcana indizieren

Die Indexerstellung erfolgt synchron, d. h., die HTTP-Anfrage antwortet erst, wenn der Index erstellt wurde. Wenn die Anfrage abgebrochen wird, wird die Indexerstellung im Hintergrund weiterhin abgeschlossen.

Vollständige Liste der Routen

Die Liste aller verfügbaren Routen finden Sie unter:

  • Im Web-Browser: https://chat-ai.academiccloud.de/arcanas/api/v1/docs
  • Über die API: https://chat-ai.academiccloud.de/v1/arcanas/api/v1/openapi.json

Beachten Sie, dass die Routen relativ sind, d. h., sie müssen mit https://chat-ai.academiccloud.de/v1/arcanas/api/v1 präfixiert werden.