Model Aliases
A model alias is a stable public name for a model. Clients send the alias as the model name in their requests. Later you can point the alias at another model, and those clients keep working without a change.
Model Gateway describes how a caller uses an alias, and API Keys describes how a key is granted on one. This page covers creating and managing aliases.
Every alias belongs to the platform. You need permission to manage models on the platform to create or change one. Open Model aliases in the sidebar under Manage platform.
The alias list
The list shows every alias on the platform, with the columns Public model ID, Display name, Target kind, Target, Unlisted and Sharing. Every row also has a delete button. Select an alias's public model ID to open its page. The search box finds an alias by its ID, its display name, or its target.
Creating an alias
Create model alias opens the create form.
| Field | What to enter |
|---|---|
| Public model ID | The name clients send in the model field. Required. From 2 to 128 characters. It must start and end with a letter or a number, and may contain letters, numbers, dots, underscores, slashes and hyphens. |
| Display name | A friendly name, shown in the portal. Optional. |
| Target kind | Model deployment or External model. |
| Target model | The model this alias points at. |
| Unlisted | See Unlisted aliases. |
Target model offers only models owned by the platform. A model that belongs to a single tenant is not offered, and the platform refuses an alias that points at one.
Select Create alias. The new alias's own page opens.
Deleting an alias
Delete alias on the alias's page asks you to confirm first. After the delete, requests that send the alias's public model ID stop working. The model the alias pointed at is not deleted.
Changing an alias
Open the alias and select the pencil button. You can change the Display name, the Target kind and Target model, and the Unlisted setting. The Public model ID cannot be changed after the alias is created.
When you pick a different target, a warning appears under the target field:
Changing the target repoints this alias to a different model. All existing API-key grants and sharing settings stay on the alias, but the new model may have different capabilities, availability, or access rules. Users who can invoke this alias will send requests to the new model.
So you do not have to grant access again after a repoint. Check first that the new model can do what the callers of this alias expect.
Select Save changes to keep the change, or Cancel to leave the alias as it was.
Access
The Access section on an alias's page decides which tenants can call the alias.
- Share with all tenants — every user on the platform can call this alias.
- Shared with tenants — only members of the tenants you select can call this alias.
Select Save access to apply the change. Choosing tenants needs platform tenant-management access. Without it, saving keeps the selected tenants unchanged.
The Sharing column in the alias list is a summary of the same setting: Everyone, the number of tenants, or Private when the alias is shared with nobody.
Unlisted aliases
Turn Unlisted on to keep an alias out of the model list that GET /v1/models returns, and out of the model pickers in the portal.
The alias still works. A user or an API key with access to it can still send requests to it, and the alias still resolves to its target model. Unlisted changes what is shown, not who has access.
An administrator still sees the alias in the platform alias list, marked Unlisted. You can change the setting at any time from the alias's edit form.
What a tenant sees
Every member of a tenant has a Model aliases entry in the tenant sidebar. The list shows the aliases that tenant may call, with the columns Public model ID, Display name, Target kind, Target and Unlisted. There is no sharing column and there are no controls for creating, changing or deleting an alias.
Select an alias to open a read-only page with the same fields. The page ends with the note This alias is managed at the platform level. If you may manage models on the platform, Manage this alias opens the alias's platform page. If you may not, the note asks you to contact your platform administrator.
If an alias you expect is not in the list, ask a platform administrator to share it with your tenant, as described under Access.