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

# List hosted OpenAI-compatible models.

Calls without an owner-scoped key return an empty OpenAI-compatible list. A valid customer gateway key lists eligible models on that account's machines, respecting key scope, machine mode, account policy and live route health. The keyed response is uncached; availability can change before the next chat request. Private node identifiers and credentials are not published in this response. 

` GET /v1/api/models `

List hosted OpenAI-compatible models.

Calls without an owner-scoped key return an empty OpenAI-compatible list.
A valid customer gateway key lists eligible models on that account's
machines, respecting key scope, machine mode, account policy and live
route health. The keyed response is uncached; availability can change
before the next chat request. Private node identifiers and credentials
are not published in this response.


## Servers

- ` https://b3iq.org ` — Public hosted gateway facade.

## Parameters

### ` b3iq_metadata ` (query, optional)

Set true to include conservative metadata from the live serving profiles.

- ` value `: type ` boolean `

### ` node_id ` (query, optional)

With b3iq_metadata=true, narrow discovery to one permitted owned machine. Empty or repeated pins are rejected.

- ` value `: type ` string `

  - minLength: ` 1 `

## Responses

### ` 200 ` — OpenAI-compatible model list.

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` object `, ` data `

  - ` object `: type ` string `

    - enum: ` ["list"] `

  - ` data `: type ` array `

    - ` array item `: type ` object `

      - Required fields: ` id `, ` object `, ` created `, ` owned_by `

      - ` b3iq `: type ` object ` — Present only with b3iq_metadata=true; context is the configured serving window, not the model's native maximum.

        - ` modality `: type ` string `

        - ` context_window_tokens `: type ` unknown `

          - ` anyOf alternative 1 `: type ` integer `

            - minimum: ` 1 `

          - ` anyOf alternative 2 `: type ` null `

        - ` input_modalities `: type ` array `

          - ` array item `: type ` string `

        - ` capabilities `: type ` array `

          - ` array item `: type ` string `

      - ` id `: type ` string `

      - ` object `: type ` string `

        - enum: ` ["model"] `

      - ` created `: type ` integer ` — Unix timestamp from the freshest observed benchmark, or 0.

      - ` owned_by `: type ` string `

        - enum: ` ["b3iq"] `

### ` default ` — OpenAI-compatible error with B3IQ metadata.

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` object `

    - Required fields: ` message `, ` type `, ` code `, ` b3iq `

    - ` message `: type ` string `

    - ` type `: type ` string `

    - ` param `: type ` unknown ` — A string value or null.

      - ` anyOf alternative 1 `: type ` string `

      - ` anyOf alternative 2 `: type ` null `

    - ` code `: type ` string `

    - ` b3iq `: type ` object `

      - Required fields: ` status `, ` title `, ` detail `, ` code `

      - ` status `: type ` integer `

      - ` title `: type ` string `

      - ` detail `: type ` string `

      - ` code `: type ` string `

      - ` job_id `: type ` string `

      - ` billing_lookup `: type ` string `

      - ` idempotency_status `: type ` string `

## Request examples

### cURL

```curl
curl -X GET 'https://b3iq.org/v1/api/models'
```

### JavaScript

```javascript
const response = await fetch('https://b3iq.org/v1/api/models', {
  method: 'GET'
});

const data = await response.json();
console.log(data);
```