Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

API Reference
Models
List Available Models
models.list(ModelListParams**kwargs) -> linksAPILinksmetaAPIMetamodelslistModelListResponse
get/v2/gen-ai/models

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

Parameters
pageint
optional

Page number.

per_pageint
optional

Items per page.

public_onlybool
optional

Only include models that are publicly available.

usecaseslist
optional
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
Hide ParametersShow Parameters
"MODEL_USECASE_UNKNOWN"
"MODEL_USECASE_AGENT"
"MODEL_USECASE_FINETUNED"
"MODEL_USECASE_KNOWLEDGEBASE"
"MODEL_USECASE_GUARDRAIL"
"MODEL_USECASE_REASONING"
"MODEL_USECASE_SERVERLESS"
Returns
ModelListResponseclass

A list of models

Hide ParametersShow Parameters
metaAPIMeta
optional

Meta information about the data set

modelslist
optional
Optional[List[agreementAPIAgreementcreated_atdatetimeis_foundationalboolnamestrparent_uuidstrupdated_atdatetimeupload_completeboolurlstruuidstrversionAPIModelVersionAPIModel]]

The models

Hide ParametersShow Parameters
agreementAPIAgreement
optional

Agreement Description

created_atdatetime
optional

Creation date / time

formatdate-time
is_foundationalbool
optional

True if it is a foundational model provided by do

namestr
optional

Name of the model

parent_uuidstr
optional

Unique id of the model, this model is based on

updated_atdatetime
optional

Last modified

formatdate-time
upload_completebool
optional

Model has been fully uploaded

urlstr
optional

Download url

uuidstr
optional

Unique id

versionAPIModelVersion
optional

Version Information about a Model

from do_gradientai import GradientAI

client = GradientAI()
models = client.models.list()
print(models.links)
200 Example
{
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  },
  "models": [
    {
      "agreement": {
        "description": "\"example string\"",
        "name": "\"example name\"",
        "url": "\"example string\"",
        "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
      },
      "created_at": "2021-01-01T00:00:00Z",
      "is_foundational": true,
      "name": "Llama 3.3 (70b)",
      "parent_uuid": "\"12345678-1234-1234-1234-123456789012\"",
      "updated_at": "2021-01-01T00:00:00Z",
      "upload_complete": true,
      "url": "https://example.com/model.zip",
      "uuid": "\"12345678-1234-1234-1234-123456789012\"",
      "version": {
        "major": 123,
        "minor": 123,
        "patch": 123
      }
    }
  ]
}