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:

• Auflisten konfigurierter KI-Provider und Auflösen des Standard-Providers
• Ausführen synchroner KI-Anfragen gegen einen Provider
• Hochladen von Ressourcen zu Providern, die Uploads unterstützen
• Auflisten konfigurierter KI-Skills
• Proxyn OpenAI-kompatibler Chat Completions zum Standard-KI-Provider

In dieser API ist providerId der konfigurierte Anzeigename des Providers. Der Anzeigename muss eindeutig sein.

• Fehlt providerId oder ist er leer, wird der Standard-Provider verwendet. Der Standard-Provider ist der erste konfigurierte Provider.
• Pfad- und Query-Token werden URL-dekodiert. Der Abgleich ist unabhängig von Groß- und Kleinschreibung.
• Token akzeptieren außerdem eine hyphenisierte Form, bei der Leerzeichen durch - ersetzt werden.
• Für 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: