models

Set or update the user default model

Changed on

Sets the specified permitted model as the user default. If a default already exists, it will be updated to the new model.

put/models/user/default

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

permittedModelIdstring required

The ID of the permitted model to set as default

Example request

{
  "permittedModelId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Successfully set or updated the user default model

idstring required

The id of the permitted model

namestring required

The name of the model

provider'openai' | 'anthropic' | 'bedrock' | 'mistral' | 'ollama' | 'synaforce' | 'ayunis' | 'otc' | 'azure' | 'gemini' | 'stackit' | 'scaleway' required

The provider of the model

providerDisplayNamestring required

The display name of the provider

displayNamestring required

The display name of the model

isArchivedboolean required

Whether the model is archived

modelIdstring required

The catalog model UUID

type'language' required

The type of the model (always language)

canStreamboolean required

Whether the model can stream

isReasoningboolean required

Whether the model can reason

canVisionboolean required

Whether the model supports vision (image processing)

contextWindowSizeinteger nullable

Maximum context window size in tokens

hasProviderFaultboolean required

Whether the upstream provider currently has a known fault for this model

isDefaultboolean required

Whether this is the default model

anonymousOnlyboolean required

Whether this model enforces anonymous mode

tier'zero' | 'low' | 'medium' | 'high' nullable

Resource-usage tier of the model, used to categorise models for the user (e.g. fast vs. powerful)

descriptionstring nullable

User-facing description of the model, shown in the model selector info card. Maintained by super admins.

Changes