API Reference

Models

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve model

Model models().retrieve(ModelRetrieveParamsparams = ModelRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/models/{model}

Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

ParametersExpand Collapse

ModelRetrieveParams params

Optional<String> model

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.

Retrieve model

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.Model;
import com.openai.models.models.ModelRetrieveParams;

public final class Main {
    private Main() {}

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

        Model model = client.models().retrieve("gpt-4o-mini");
    }
}

200 example

{
  "id": "id",
  "created": 0,
  "object": "model",
  "owned_by": "owned_by"
}

Returns Examples

200 example

{
  "id": "id",
  "created": 0,
  "object": "model",
  "owned_by": "owned_by"
}