Skip to content

List models

models.list() -> Page<Model { id, created, object, owned_by } >
GET/models

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

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.

List models

require "openai"

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

page = openai.models.list

puts(page)
{
  "data": [
    {
      "id": "id",
      "created": 0,
      "object": "model",
      "owned_by": "owned_by"
    }
  ],
  "object": "list"
}
Returns Examples
{
  "data": [
    {
      "id": "id",
      "created": 0,
      "object": "model",
      "owned_by": "owned_by"
    }
  ],
  "object": "list"
}