# Models

## List

`models.list(ModelListParams**kwargs)  -> ModelListResponse`

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

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

### Parameters

- **page:** `int`

  Page number.

- **per\_page:** `int`

  Items per page.

- **public\_only:** `bool`

  Only include models that are publicly available.

- **usecases:** `List[Literal["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

- `class ModelListResponse`

  A list of models

  - **links:** `Optional[APILinks]`

    Links to other pages

  - **meta:** `Optional[APIMeta]`

    Meta information about the data set

  - **models:** `Optional[List[APIModel]]`

    The models

    - **agreement:** `Optional[APIAgreement]`

      Agreement Description

    - **created\_at:** `Optional[datetime]`

      Creation date / time

    - **is\_foundational:** `Optional[bool]`

      True if it is a foundational model provided by do

    - **name:** `Optional[str]`

      Name of the model

    - **parent\_uuid:** `Optional[str]`

      Unique id of the model, this model is based on

    - **updated\_at:** `Optional[datetime]`

      Last modified

    - **upload\_complete:** `Optional[bool]`

      Model has been fully uploaded

    - **url:** `Optional[str]`

      Download url

    - **uuid:** `Optional[str]`

      Unique id

    - **version:** `Optional[APIModelVersion]`

      Version Information about a Model

### Example

```python
from do_gradientai import GradientAI

client = GradientAI()
models = client.models.list()
print(models.links)
```

## Domain Types

### API Agreement

- `class APIAgreement`

  Agreement Description

  - **description:** `Optional[str]`

  - **name:** `Optional[str]`

  - **url:** `Optional[str]`

  - **uuid:** `Optional[str]`

### API Model

- `class APIModel`

  A machine learning model stored on the GenAI platform

  - **agreement:** `Optional[APIAgreement]`

    Agreement Description

  - **created\_at:** `Optional[datetime]`

    Creation date / time

  - **is\_foundational:** `Optional[bool]`

    True if it is a foundational model provided by do

  - **name:** `Optional[str]`

    Name of the model

  - **parent\_uuid:** `Optional[str]`

    Unique id of the model, this model is based on

  - **updated\_at:** `Optional[datetime]`

    Last modified

  - **upload\_complete:** `Optional[bool]`

    Model has been fully uploaded

  - **url:** `Optional[str]`

    Download url

  - **uuid:** `Optional[str]`

    Unique id

  - **version:** `Optional[APIModelVersion]`

    Version Information about a Model

### API Model Version

- `class APIModelVersion`

  Version Information about a Model

  - **major:** `Optional[int]`

    Major version number

  - **minor:** `Optional[int]`

    Minor version number

  - **patch:** `Optional[int]`

    Patch version number