List Assistant Models

The models the user may pick for a chat (RO-320): catalog models whose provider has a key here (the workspace's own provider, else the platform's free-tier keys), allowed by the workspace admin (models whose free tier may train on prompts only when the allow-list names them), not retired and still listed by their provider; plus Auto and the workspace default. Each has speed, quality, a credits weight and its lifecycle.

API key access

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

GET/api/v1/assistant/models

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/assistant/models" \
  -H "X-Workspace-Id: string"

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

{
  "auto": {
    "id": "string",
    "label": "string",
    "description": "string"
  },
  "default_model": "string",
  "show_credits": true,
  "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
      }
    }
  ]
}

Authorization

Header Parameters

Response Body

200