Sign in
aliases

Set Organization Alias

Changed on

Create or update a stored alias in one of the organization's workspaces.

Organization owners and admins only, with the same two scope rules the policy write has: workspace_id is required and resolved inside the caller's organization, and user_id is not accepted.

post/api/v1/organizations/me/aliases

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

namestring required

Display name callers use as the model, e.g. 'fast-model'.

targetstring required

Selector the alias resolves to, as 'provider:model' or 'instance:model'.

user_idstring nullable

User this alias belongs to. Omit for an alias every caller in the workspace sees. A user-scoped alias resolves only for that user and shadows the workspace-wide one of the same name.

workspace_idstring uuid nullable

Workspace this alias belongs to. Omit for the deployment's default workspace. The alias resolves only for requests in that workspace, so two workspaces can each point the same name at a different model.

Response

Successful Response

created_atstring nullable
namestring required
sourcestring required
targetstring required
updated_atstring nullable
user_idstring nullable
workspace_idstring uuid nullable

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id set_organization_alias_api_v1_organizations_me_aliases_post removed and replaced with aliases-set_organization_alias