AI
The AI Web API is an interface to access configured AI providers, skills, request execution, resource upload, and an OpenAI-compatible chat completions proxy.
Requests have to be sent as HTTP requests with the scheme https://[HOST]:[PORT]/api/ai/[Command]. To access the AI Web API a user has to have the required permissions - which have to be set in the configuration manager. All clients have to be authenticated in order to use the API.
Note: The AI Web API can be used only by users who have both the Web API and ai.api permissions set. All clients must be authenticated.
Features
The AI Web API exposes the following features:
- Listing configured AI providers and resolving the default provider
- Running synchronous AI requests against a provider
- Uploading resources to providers that support uploads
- Listing configured AI skills
- Proxying OpenAI-compatible chat completions to the default AI provider
Provider Identifier
In this API, providerId is the configured provider display name. The display name must be unique.
- If
providerIdis omitted or empty, the default provider is used. The default provider is the first configured provider. - Path and query tokens are URL-decoded. Matching is case-insensitive.
- Tokens also accept a hyphenized form where spaces are replaced by
-. - For
GET /api/ai/providers/default, the literal path tokendefaultresolves the default provider.
Commands
The following commands are available for the AI Web API:
| Command | Description |
|---|---|
| Providers | Lists configured AI providers and returns details for one provider |
| AI Requests | Runs a synchronous AI request against a provider |
| Resource Uploads | Uploads a file to an AI provider that supports uploads |
| Skills | Lists configured AI skills |
| Chat Completions Proxy | OpenAI-compatible chat completions proxy for the default AI provider |
