Skip to content

Retrieve model

models.retrieve(model) -> 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
class 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: Integer

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

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

model = openai.models.retrieve("gpt-4o-mini")

puts(model)
{
  "id": "id",
  "created": 0,
  "object": "model",
  "owned_by": "owned_by"
}
Returns Examples
{
  "id": "id",
  "created": 0,
  "object": "model",
  "owned_by": "owned_by"
}