Workspaces

Update Assistant Settings

Admins: which catalog models members may pick (null = every available one), the default model (one of them), and whether previews and credits show (RO-320). Fields left out keep their value. Retired models can't be allowed.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
PUT/api/v1/workspaces/current/assistant-settings
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

allowed_models?array<string> | null

Catalog ids (at most 50); null = every available model.

default_model?string | null

One of allowed_models (when set); null = the server's default.

show_credits?boolean | null
allow_preview?boolean | null

Response Body

curl -X PUT "http://localhost:8000/api/v1/workspaces/current/assistant-settings" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "allowed_models": [
    "string"
  ],
  "default_model": "string",
  "show_credits": true,
  "allow_preview": true,
  "own_provider": "string",
  "live_checked_at": "2019-08-24T14:15:22Z",
  "models": [
    {
      "id": "string",
      "provider": "string",
      "model": "string",
      "label": "string",
      "description": "string",
      "speed": "string",
      "quality": "string",
      "context_tokens": 0,
      "credits_weight": 0.1,
      "free_tier": true,
      "trains_on_prompts": true,
      "structured_output": "string",
      "status": "ga",
      "deprecation_date": "2019-08-24",
      "retirement_date": "2019-08-24",
      "replacement": "string",
      "capabilities": {
        "structured_output": true,
        "tool_use": true,
        "vision": true,
        "long_context": true
      },
      "available": true,
      "unavailable_reason": "string",
      "offered": true
    }
  ],
  "warnings": [
    {
      "model": "string",
      "label": "string",
      "status": "ga",
      "retirement_date": "2019-08-24",
      "replacement": "string",
      "where": "string",
      "message": "string"
    }
  ],
  "refresh": {
    "property1": null,
    "property2": null
  }
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}