# Models

### List models

`GET /v1/models` openapi

AlphaNeural also exposes `GET /models` as an alias for compatibility. openapi

#### Authentication

Send your key in the `Authorization` header.

```bash
-H "Authorization: Bearer $ALPHANEURAL_API_KEY"
```

### Query parameters

These are optional. If you do not pass anything, you get the default model list for your key. openapi

* `return_wildcard_routes` (boolean). Include wildcard routes in the returned list.
* `team_id` (string). Filter models by team.
* `include_model_access_groups` (boolean). Include model access group information. 
* `only_model_access_groups` (boolean). Return only model access groups.
* `include_metadata` (boolean). Include additional metadata in the response with fallback information.
* `fallback_type` (string). Which fallback class to include when `include_metadata=true`. Supported values include `general`, `context_window`, `content_policy`.

{% hint style="info" %}
For richer model details like pricing, mode, and config-derived metadata, the spec recommends using `/v1/model/info`. This page focuses on OpenAI-compatible listing for developer tooling compatibility. 
{% endhint %}

### Examples

#### cURL

```bash
curl https://proxy.alfnrl.io/v1/models \
  -H "Authorization: Bearer $ALPHANEURAL_API_KEY"
```

With metadata and fallback info:

```bash
curl "https://proxy.alfnrl.io/v1/models?include_metadata=true&fallback_type=general" \
  -H "Authorization: Bearer $ALPHANEURAL_API_KEY"
```

#### Python (OpenAI SDK style)

```python
from openai import OpenAI
import os
client = OpenAI(api_key=os.environ["ALPHANEURAL_API_KEY"], base_url="https://proxy.alfnrl.io/v1")
models = client.models.list()
print([m.id for m in models.data][:10])
```

#### JavaScript/TypeScript (OpenAI SDK style)

```js
import OpenAI from "openai";
const client = new OpenAI({ apiKey: process.env.ALPHANEURAL_API_KEY, baseURL: "https://proxy.alfnrl.io/v1" });
const models = await client.models.list();
console.log(models.data.map(m => m.id).slice(0, 10));
```

### Response

Returns an OpenAI-style “list” of model objects. The exact fields can vary by upstream and by whether you enable metadata. openapi

Example shape (illustrative):

```json
{
  "object": "list",
  "data": [
    { "id": "gpt-4o-mini", "object": "model", "owned_by": "alphaneural" },
    { "id": "qwen3", "object": "model", "owned_by": "alphaneural" }
  ]
}
```

### Related

* Retrieve a specific model: `GET /v1/models/{model_id}`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.alphaneural.io/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.