Skip to main content
Version: 3.1

AI Provider

AI Providers are the bridge between Operaide and the large language models that power its AI features. Each provider configuration tells the platform how to connect to an external AI service — which API endpoint to call, which credentials to use, and which models to expose to reaktors and other platform features.

You manage AI Providers from Connections > AI Provider in the sidebar.


Overview

The AI Provider management page lets you:

  • Register connections to one or more AI services (e.g. OpenAI, Anthropic, Azure OpenAI)
  • Configure API credentials and provider-specific settings in JSON
  • Define one or many model configurations per provider (each with its own model ID and parameters)
  • Activate or deactivate providers without deleting them
  • Test a provider's models directly from the editor
  • Import and export provider configurations as JSON for backup or transfer between environments

Supported Providers

Operaide ships with built-in support for the following AI providers:

ProviderType identifierNotes
OpenAIopenaiGPT-4o, GPT-4o-mini, o-series, and other OpenAI models
AnthropicanthropicClaude model family
Azure OpenAIazureOpenAI models hosted on Microsoft Azure
Azure AIazureAiAzure AI services beyond OpenAI
Google GenerativegoogleGenerativeGemini models via the Google AI Studio API
Google VertexgoogleVertexGemini and other models via Google Cloud Vertex AI
Amazon BedrockamazonBedrockModels hosted on AWS Bedrock
GroqgroqHigh-speed inference for open-source models
MistralmistralMistral AI models
CoherecohereCohere language models
DeepSeekdeepseekDeepSeek models
CerebrascerebrasCerebras inference
OllamaollamaSelf-hosted open-source models via Ollama

Each provider type comes with an example configuration that pre-fills the JSON editor when you select it, giving you a template to adapt.


Managing AI Providers

Viewing Providers

The AI Provider list page shows all configured providers for your organisation in a table with the following columns:

ColumnDescription
IDThe immutable readable ID assigned at creation
NameThe display name of the provider
ProviderThe provider type (e.g. openai, anthropic)
StatusA badge showing Active or Inactive
Created AtTimestamp of when the provider was created
Updated AtTimestamp of the last modification
ActionsEdit and Delete buttons (visibility depends on your permissions)

Use the search bar at the top to filter providers by name, readable ID, or provider type.


Creating a Provider

  1. Click the Create button (top-right).
  2. Fill in the following fields:
FieldDescription
Readable IDA short, unique identifier with no whitespace (min. 3 characters). This cannot be changed after creation.
NameA human-readable display name (min. 3 characters, must be unique within your organisation).
ActiveToggle to activate or deactivate the provider. Defaults to active.
Provider TypeSelect from the list of supported providers. An icon and label help you identify each option.
Configuration (JSON)A code editor where you enter the provider-specific configuration and model definitions.
  1. The Configuration editor uses the following JSON structure:
{
"providerConfig": {
"apiKey": "your-api-key",
"baseURL": "https://api.example.com/v1"
},
"modelConfig": [
{
"id": "operaide.provider.model-name",
"resourceId": "actual-model-id",
"type": "chat"
}
]
}
  • providerConfig contains API credentials and connection settings (differs per provider type).
  • modelConfig is an array of model definitions. Each entry needs at least:
    • id — the application-level model ID used within Operaide (no whitespace)
    • resourceId — the model ID as expected by the provider's API
    • type"chat", "embedding", or "custom" (defaults to "chat")
tip

When you select a provider type, the editor is pre-filled with an example configuration including documentation links. Use this as a starting point and replace the placeholder values with your actual credentials and model IDs.

  1. Click Save to create the provider.

Editing a Provider

Open a provider by clicking Edit in the actions column. All fields are editable except the Readable ID, which is immutable after creation.


Deleting a Provider

Click Delete in the actions column. A confirmation dialog asks:

"Do you really want to delete the provider {name}?"

Confirm to permanently remove the provider and all its model configurations.


Testing a Provider

The built-in AI Provider Tester lets you verify that a provider configuration works before using it in production.

  1. In the provider editor, click Test Provider to open the tester modal.
  2. Select a Test Model from the dropdown. The list is populated from the model configurations defined in the JSON editor.
  3. Enter a Test Message (a default prompt is pre-filled).
  4. Click Send Test Message.

The tester displays results across five tabs:

TabContent
RequestThe raw API request object sent to the provider
ResponseThe raw API response received
UsageToken counts, cost estimates, and other usage metrics
WarningsAny warnings returned by the provider
ErrorsError details if the test failed

The Test Response field shows the model's reply as plain text.

note

The tester uses the configuration as currently entered in the editor — you do not need to save the provider first. This makes it easy to experiment with different settings.


Import and Export

Exporting a Provider

In the provider editor, click Export. The full provider configuration is copied to your clipboard as a JSON object. You can paste it into a file for backup or share it with colleagues.

Importing a Provider

  1. On the AI Provider list page, click Import.
  2. A modal opens with a large text area.
  3. Paste a valid AI Provider JSON configuration.
  4. Click OK to validate and save the imported provider.

The import validates the JSON against the expected schema. If the JSON is malformed or missing required fields, you receive an error notification.


Permissions

Access to AI Provider features is controlled by the following permissions:

PermissionDescriptionDefault roles
Use AI ProviderUse AI providers for AI-powered featuresOrganisation Member
View AI ProviderView AI provider configurationsApp Developer, Credential Manager
Edit AI ProviderCreate and modify AI provider configurationsCredential Manager
Delete AI ProviderDelete AI provider configurationsCredential Manager
View Default AI ProviderView the default AI provider settingsAny logged-in user
warning

Only users with the Credential Manager role can create, edit, or delete AI Providers. If you need access, contact your organisation administrator.