## List

`client.models.list(ModelListParamsquery?, RequestOptionsoptions?): ModelListResponse`

**get** `/v2/gen-ai/models`

To list all models, send a GET request to `/v2/gen-ai/models`.

### Parameters

- `query: ModelListParams`

  - `page?: number`

    Page number.

  - `per_page?: number`

    Items per page.

  - `public_only?: boolean`

    Only include models that are publicly available.

  - `usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>`

    Include only models defined for the listed usecases.

    - MODEL_USECASE_UNKNOWN: The use case of the model is unknown
    - MODEL_USECASE_AGENT: The model maybe used in an agent
    - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning
    - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models)
    - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails
    - MODEL_USECASE_REASONING: The model usecase for reasoning
    - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference

    - `"MODEL_USECASE_UNKNOWN"`

    - `"MODEL_USECASE_AGENT"`

    - `"MODEL_USECASE_FINETUNED"`

    - `"MODEL_USECASE_KNOWLEDGEBASE"`

    - `"MODEL_USECASE_GUARDRAIL"`

    - `"MODEL_USECASE_REASONING"`

    - `"MODEL_USECASE_SERVERLESS"`

### Returns

- `ModelListResponse`

  A list of models

  - `links?: APILinks`

    Links to other pages

    - `pages?: Pages`

      Information about how to reach other pages

      - `first?: string`

        First page

      - `last?: string`

        Last page

      - `next?: string`

        Next page

      - `previous?: string`

        Previous page

  - `meta?: APIMeta`

    Meta information about the data set

    - `page?: number`

      The current page

    - `pages?: number`

      Total number of pages

    - `total?: number`

      Total amount of items over all pages

  - `models?: Array<APIModel>`

    The models

    - `id?: string`

      Human-readable model identifier

    - `agreement?: APIAgreement`

      Agreement Description

      - `description?: string`

      - `name?: string`

      - `url?: string`

      - `uuid?: string`

    - `created_at?: string`

      Creation date / time

    - `is_foundational?: boolean`

      True if it is a foundational model provided by do

    - `name?: string`

      Display name of the model

    - `parent_uuid?: string`

      Unique id of the model, this model is based on

    - `updated_at?: string`

      Last modified

    - `upload_complete?: boolean`

      Model has been fully uploaded

    - `url?: string`

      Download url

    - `uuid?: string`

      Unique id

    - `version?: APIModelVersion`

      Version Information about a Model

      - `major?: number`

        Major version number

      - `minor?: number`

        Minor version number

      - `patch?: number`

        Patch version number

### Example

```typescript
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const models = await client.models.list();

console.log(models.links);
```