List

API Reference

Models

List Available Models

client.models.list(?, ?): ModelListResponse { links, meta, models }

get/v2/gen-ai/models

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

ParametersExpand Collapse

query: ModelListParams { page, per_page, public_only, usecases }

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

Accepts one of the following:

"MODEL_USECASE_UNKNOWN"

"MODEL_USECASE_AGENT"

"MODEL_USECASE_FINETUNED"

"MODEL_USECASE_KNOWLEDGEBASE"

"MODEL_USECASE_GUARDRAIL"

"MODEL_USECASE_REASONING"

"MODEL_USECASE_SERVERLESS"

ReturnsExpand Collapse

ModelListResponse { links, meta, models }

A list of models

links?: APILinks { pages }

Links to other pages

pages?: Pages { first, last, next, previous }

Information about how to reach other pages

first?: string

First page

last?: string

Last page

next?: string

previous?: string

meta?: APIMeta { page, pages, total }

Meta information about the data set

page?: number

The current page

formatint64

pages?: number

Total number of pages

formatint64

total?: number

Total amount of items over all pages

formatint64

models?: Array<APIModel { id, agreement, created_at, 8 more } >

The models

id?: string

Human-readable model identifier

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string

name?: string

url?: string

uuid?: string

created_at?: string

Creation date / time

formatdate-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

formatdate-time

upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

uuid?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64

minor?: number

Minor version number

formatint64

patch?: number

Patch version number

formatint64

List Available Models

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

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

console.log(models.links);

{
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  },
  "models": [
    {
      "id": "llama3.3-70b-instruct",
      "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 Instruct (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
      }
    }
  ]
}

Returns Examples

{
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  },
  "models": [
    {
      "id": "llama3.3-70b-instruct",
      "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 Instruct (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
      }
    }
  ]
}