Skip to content

List

List Available Models
get/v2/gen-ai/models

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

Query Parameters
pagenumber
optional

page number.

formatint64
per_pagenumber
optional

items per page.

formatint64
public_onlyboolean
optional

only include models that are publicly available.

usecasesarray of enum
optional

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
metapagenumberpagesnumbertotalnumberAPIMeta
optional
modelsarray of agreementAPIAgreementcreated_atstringis_foundationalbooleannamestringparent_uuidstringupdated_atstringupload_completebooleanurlstringuuidstringversionAPIModelVersionAPIModel
optional
Request example cURL
curl https://api.digitalocean.com//v2/gen-ai/models \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "links": {
    "pages": {
      "first": "first",
      "last": "last",
      "next": "next",
      "previous": "previous"
    }
  },
  "meta": {
    "page": 0,
    "pages": 0,
    "total": 0
  },
  "models": [
    {
      "agreement": {
        "description": "description",
        "name": "name",
        "url": "url",
        "uuid": "uuid"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_foundational": true,
      "name": "name",
      "parent_uuid": "parent_uuid",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "upload_complete": true,
      "url": "url",
      "uuid": "uuid",
      "version": {
        "major": 0,
        "minor": 0,
        "patch": 0
      }
    }
  ]
}