Skip to navigation

Get Model Alias

Get one model alias.

Needs view_routing or manage_routing.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

alias_idstringRequiredformat: "uuid"

The alias’s id.

Response

The model alias
created_atdatetimeRead-only
When the alias was created.
descriptionstring or null
What the alias is for.
full_namestringRead-only

@alias/<name>, the value clients send as model.

idstringRead-onlyformat: "uuid"
The alias's id.
is_activeboolean
Whether the alias is active.
managed_by"routing_policy" or nullRead-only

routing_policy for the slug a routing policy owns; null for your own aliases.

namestring

The alias, without the @alias/ prefix.

project_idstring or nullformat: "uuid"

The project the alias applies to; null for the whole organization.

target_modelstring or null

Set when target_type is model.

target_policy_idstring or null

Set when target_type is routing_config.

target_typeenum

model resolves to one model; routing_config to a routing policy.

Allowed values:
updated_atdatetimeRead-only
When the alias last changed.
vendorstring or null
The vendor the target model is pinned to, if any.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error