Skip to content
API Reference
Models

Retrieve model

client.models.retrieve(stringmodel, RequestOptionsoptions?): Model { id, created, object, owned_by }
GET/models/{model}

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

ParametersExpand Collapse
model: string
ReturnsExpand Collapse
Model { id, created, object, owned_by }

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

id: string

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

created: number

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

object: "model"

The object type, which is always "model".

owned_by: string

The organization that owns the model.

Retrieve model

import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const model = await openai.models.retrieve("VAR_chat_model_id");

  console.log(model);
}

main();
{
  "id": "VAR_chat_model_id",
  "object": "model",
  "created": 1686935002,
  "owned_by": "openai"
}
Returns Examples
{
  "id": "VAR_chat_model_id",
  "object": "model",
  "created": 1686935002,
  "owned_by": "openai"
}