Get Assistant Settings

Admins: the model catalog with each model's availability and lifecycle, the models members may pick, the default, whether previews and credits show, and warnings for deprecated or retired models still in use (RO-320). Models whose free tier may train on prompts (`trains_on_prompts`) are only offered when the allow-list names them.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.

GET/api/v1/workspaces/current/assistant-settings

Authorization

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).

Response Body

curl -X GET "http://localhost:8000/api/v1/workspaces/current/assistant-settings" \
  -H "X-Workspace-Id: string"

curl -X GET "http://localhost:8000/api/v1/workspaces/current/assistant-settings" \  -H "X-Workspace-Id: string"

{
  "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

Authorization

Header Parameters

Response Body

200

403