Die KI-Web-API ist eine Schnittstelle für konfigurierte KI-Provider, Skills, Anfrageausführung, Ressourcen-Upload und einen OpenAI-kompatiblen Chat-Completions-Proxy.
Anfragen müssen als HTTP-Requests mit dem Schema https://[HOST]:[PORT]/api/ai/[Command] gesendet werden. Für den Zugriff auf die KI-Web-API muss der Benutzer die erforderlichen Berechtigungen haben – diese werden im Konfigurationsmanager gesetzt. Alle Clients müssen authentifiziert sein, um die API zu nutzen.
Hinweis: Die KI-Web-API kann nur von Benutzern verwendet werden, die sowohl die Berechtigung Web API als auch ai.api besitzen. Alle Clients müssen authentifiziert sein.
Die KI-Web-API stellt die folgenden Funktionen bereit:
In dieser API ist providerId der konfigurierte Anzeigename des Providers. Der Anzeigename muss eindeutig sein.
providerId oder ist er leer, wird der Standard-Provider verwendet. Der Standard-Provider ist der erste konfigurierte Provider.- ersetzt werden.GET /api/ai/providers/default löst das Pfadtoken default den Standard-Provider auf.Die folgenden Befehle stehen für die KI-Web-API zur Verfügung:
| Befehl | Beschreibung |
|---|---|
| Provider | Listet konfigurierte KI-Provider und liefert Details zu einem Provider |
| KI-Anfragen | Führt eine synchrone KI-Anfrage gegen einen Provider aus |
| Ressourcen-Uploads | Lädt eine Datei zu einem KI-Provider hoch, der Uploads unterstützt |
| Skills | Listet konfigurierte KI-Skills |
| Chat-Completions-Proxy | OpenAI-kompatibler Chat-Completions-Proxy für den Standard-KI-Provider |