> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ai-stats.phaseo.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Models

> List models with the Ruby SDK.

**Method**: `client.list_models(...)`.

### Example

```ruby theme={null}
require 'ai_stats_sdk'

client = AIStatsSdk::AIStats.new(api_key: ENV.fetch("AI_STATS_API_KEY"))
models = client.list_models(
  limit: "5",
  provider: "anthropic",
  provider_status: "beta,not_ready",
  provider_availability_reason: "preview_only,provider_not_ready",
  capability_status: "coming_soon,internal_testing",
  availability: "all",
)
```

### Key parameters

* `provider` (optional): Filter by provider
* `provider_status` / `provider_routing_status` / `model_routing_status` (optional): Filter by rollout and routing state
* `capability_status` / `provider_availability_status` / `provider_availability_reason` (optional): Filter by capability and availability state
* `provider_availability_reason` is useful with `availability: "all"` when you want rollout-state entries such as `preview_only`, `provider_not_ready`, `gated`, `access_limited`, `region_limited`, `project_limited`, `paused`, or `soft_blocked`
* `capability_status` is useful with `availability: "all"` when you want non-routable endpoint mappings such as `coming_soon` or `internal_testing`
* `status` (optional): Filter by model lifecycle state
* `organisation` (optional): Filter by organisation
* `endpoints` (optional): Array of endpoints
* `input_types` / `output_types` / `params` (optional): Capability filters
* `availability` (optional): `active` or `all`
* `limit` (optional): Number
* `offset` (optional): Number

### Returns

`ModelListResponse`

```json theme={null}
{
  "ok": true,
  "limit": 50,
  "offset": 0,
  "total": 123,
  "models": [
    {
      "model_id": "openai/gpt-4o-mini",
      "name": "GPT-4o Mini",
      "release_date": "2024-07-18",
      "status": "active",
      "organisation_id": "openai",
      "aliases": ["gpt-4o-mini"],
      "endpoints": ["chat/completions", "responses"],
      "input_types": ["text"],
      "output_types": ["text"],
      "providers": [
        {
          "api_provider_id": "openai",
          "params": ["temperature", "max_tokens"]
        }
      ]
    }
  ]
}
```