API Reference

Models

Copy Markdown

Open in ChatGPT

---

Copy Markdown

View as Markdown

List models

ModelListPage models().list(ModelListParamsparams = ModelListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/models

Lists the currently available models, and provides basic information about each one such as the owner and availability.

ParametersExpand Collapse

ModelListParams params

ReturnsExpand Collapse

class Model:

Describes an OpenAI model offering that can be used with the API.

String id

The model identifier, which can be referenced in the API endpoints.

long created

The Unix timestamp (in seconds) when the model was created.

JsonValue; object_ "model"constant"model"constant

The object type, which is always "model".

String ownedBy

The organization that owns the model.

List models

Java

HTTP

TypeScript

Python

Java

Go

Ruby

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.models.ModelListPage;
import com.openai.models.models.ModelListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ModelListPage page = client.models().list();
    }
}

{
  "object": "list",
  "data": [
    {
      "id": "model-id-0",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner"
    },
    {
      "id": "model-id-1",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner",
    },
    {
      "id": "model-id-2",
      "object": "model",
      "created": 1686935002,
      "owned_by": "openai"
    },
  ]
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "id": "model-id-0",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner"
    },
    {
      "id": "model-id-1",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner",
    },
    {
      "id": "model-id-2",
      "object": "model",
      "created": 1686935002,
      "owned_by": "openai"
    },
  ]
}