Core Features

Model Credentials

View as Markdown

Model Credentials is where an Admin connects OpenModels API keys to AIvis. Each saved credential stores one encrypted API key, synchronizes the models that key can access, and exposes those models to the rest of the model configuration flow.

Adding a credential does not automatically make every model the default model. After the catalog is synchronized, use Language Models and the capability pages to choose which models are enabled for chat, image generation, video generation, STT, and TTS.

Before you begin

RequirementWhy it matters
Admin accessOnly administrators should add, rotate, refresh, or delete model credentials.
OpenModels API keyThe key is required when creating a new credential. Get it from OpenModels, then store it only in the protected form.
Approved model scopeDecide which model families the workspace is allowed to use before enabling defaults.
Network accessAIvis must be able to reach the OpenModels API from the deployment environment.

Get an OpenModels API key

If your organization already has an OpenModels account, ask the account owner for a workspace-approved API key or for access to create one. If you do not have one yet:

  1. Open OpenModels.
  2. Sign in or create an account for the organization that will pay for model usage.
  3. Purchase or activate the model access your AIvis deployment is allowed to use.
  4. Create or copy an OpenModels API key from the OpenModels account.
  5. Store the key in your team’s secret manager until you paste it into AIvis.

Use a production-owned key instead of a personal trial key for shared deployments. The same OpenModels account is also where Admins should check balance or recharge when requests report insufficient balance.

Page overview

Model Credentials page showing one synchronized OpenModels credential with available model counts, refresh, edit, and delete actions

Each credential card summarizes the synchronized catalog for one OpenModels API key.

UI elementMeaning
Credential nameAdmin-facing label used when selecting a credential in model configuration. It is not sent to the model service.
Masked keyPartial key display used only to identify which key is stored. The full key is not shown again.
Sync statusCatalog synced, Sync failed, or Never synced. Refresh the catalog after key changes or provider catalog changes.
Available / unavailable modelsAvailable models can be selected by AIvis features. Unavailable models remain visible only as catalog context or compatibility signals.
Capability countsThe catalog is grouped into language, image, video, STT, and TTS models.
Last syncedTimestamp of the last successful or attempted catalog refresh.
Card actionsEdit the name or key, refresh the catalog, or delete the credential.
Available models drawerExpands the card and lists available models by capability tab.

Add a credential

Add model credential dialog with name and OpenModels API key fields

  1. Sign in as an Admin.
  2. Open Admin Console > Model Credentials.
  3. Select Add Credential.
  4. Enter a clear Name, such as Company OpenModels key or Production OpenModels.
  5. Paste the OpenModels API Key.
  6. Select Save and sync.

AIvis saves the credential and immediately synchronizes the model catalog available to that key. If synchronization succeeds, the credential card shows Catalog synced and the available model counts. If synchronization fails, reopen the form to verify the key, then use the refresh action after correcting the problem.

The name helps Admins identify the credential later. It is not sent to OpenModels during model requests.

Review available models

Open the credential card by selecting View available models. The expanded catalog groups synchronized models by capability:

  • Language for chat, Agents, and text reasoning.
  • Image for image generation or image editing models.
  • Video for text-to-video, image-to-video, or video editing models.
  • STT for speech-to-text models.
  • TTS for text-to-speech models.

Use this view to confirm that the expected model families are visible before configuring defaults on other pages.

Refresh, edit, or delete

ActionWhen to use itBehavior
Refresh catalogThe OpenModels account gains or loses model access, or an Admin wants to retry a failed sync.AIvis fetches the current catalog for the stored key and updates model counts.
Edit credentialRename the credential or rotate the API key.When editing, leave the API key field empty to keep the stored key. Paste a new key only when rotating.
Delete credentialThe key is no longer approved or the environment no longer uses it.AIvis blocks deletion if model settings still depend on the credential. Move those settings first.

After editing or refreshing a credential, revisit Language Models, Image Generation, Video Generation, and Voice if any default model or capability binding depends on the changed catalog.

Troubleshooting

SymptomWhat to check
Save and sync is disabledName and API key are required for new credentials. Remove leading or trailing spaces.
Sync failedConfirm the OpenModels API key is valid, active, and reachable from the AIvis deployment.
Expected model is missingConfirm the key has access to that model in OpenModels, then refresh the catalog.
Model appears unavailableThe catalog entry exists, but AIvis cannot use it for the required capability. Choose an available model or review compatibility differences shown on the page.
Delete failsThe credential is still selected by one or more model settings. Move those settings to another credential first.

Security practices

Do not paste OpenModels API keys into Agent instructions, chat messages, source control, screenshots, tickets, or shared documents. Store them only through the Model Credentials form.

Use separate credentials for different environments or access boundaries. Rotate keys according to your organization’s security process, then refresh the catalog and verify that the expected model defaults still work.