Models

List models

models.list() -> Page<Model>

get /models

List models

Returns

class Model

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".
  - :model
- owned_by: String
  
  The organization that owns the model.

Example

require "openai"

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

page = openai.models.list

puts(page)

Response

{
  "data": [
    {
      "id": "id",
      "created": 0,
      "object": "model",
      "owned_by": "owned_by"
    }
  ],
  "object": "list"
}

Retrieve model

models.retrieve(model) -> Model

get /models/{model}

Retrieve model

Parameters

model: String

Returns

class Model

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".
  - :model
- owned_by: String
  
  The organization that owns the model.

Example

require "openai"

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

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

puts(model)

Response

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

Delete a fine-tuned model

models.delete(model) -> ModelDeleted

delete /models/{model}

Delete a fine-tuned model

Parameters

model: String

Returns

class ModelDeleted
- id: String
- deleted: bool
- object: String

Example

require "openai"

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

model_deleted = openai.models.delete("ft:gpt-4o-mini:acemeco:suffix:abc123")

puts(model_deleted)

Response

{
  "id": "id",
  "deleted": true,
  "object": "object"
}

Domain Types

Model

class Model

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".
  - :model
- owned_by: String
  
  The organization that owns the model.

Model Deleted

class ModelDeleted
- id: String
- deleted: bool
- object: String

ruby/resources/models/index.md +200 −0 created

1# Models

3## List models

5`models.list() -> Page<Model>`

7**get** `/models`

9List models

11### Returns

13- `class Model`

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

17 - `id: String`

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

21 - `created: Integer`

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

25 - `object: :model`

27 The object type, which is always "model".

29 - `:model`

31 - `owned_by: String`

33 The organization that owns the model.

35### Example

37```ruby

38require "openai"

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

42page = openai.models.list

44puts(page)

45```

47#### Response

49```json

50{

51 "data": [

52 {

53 "id": "id",

54 "created": 0,

55 "object": "model",

56 "owned_by": "owned_by"

57 }

58 ],

59 "object": "list"

60}

61```

63## Retrieve model

65`models.retrieve(model) -> Model`

67**get** `/models/{model}`

69Retrieve model

71### Parameters

73- `model: String`

75### Returns

77- `class Model`

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

81 - `id: String`

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

85 - `created: Integer`

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

89 - `object: :model`

91 The object type, which is always "model".

93 - `:model`

95 - `owned_by: String`

97 The organization that owns the model.

99### Example

100

101```ruby

102require "openai"

103

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

105

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

107

108puts(model)

109```

110

111#### Response

112

113```json

114{

115 "id": "id",

116 "created": 0,

117 "object": "model",

118 "owned_by": "owned_by"

119}

120```

121

122## Delete a fine-tuned model

123

124`models.delete(model) -> ModelDeleted`

125

126**delete** `/models/{model}`

127

128Delete a fine-tuned model

129

130### Parameters

131

132- `model: String`

133

134### Returns

135

136- `class ModelDeleted`

137

138 - `id: String`

139

140 - `deleted: bool`

141

142 - `object: String`

143

144### Example

145

146```ruby

147require "openai"

148

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

150

151model_deleted = openai.models.delete("ft:gpt-4o-mini:acemeco:suffix:abc123")

152

153puts(model_deleted)

154```

155

156#### Response

157

158```json

159{

160 "id": "id",

161 "deleted": true,

162 "object": "object"

163}

164```

165

166## Domain Types

167

168### Model

169

170- `class Model`

171

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

173

174 - `id: String`

175

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

177

178 - `created: Integer`

179

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

181

182 - `object: :model`

183

184 The object type, which is always "model".

185

186 - `:model`

187

188 - `owned_by: String`

189

190 The organization that owns the model.

191

192### Model Deleted

193

194- `class ModelDeleted`

195

196 - `id: String`

197

198 - `deleted: bool`

199

200 - `object: String`

ruby/resources/models/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Models

List models

Returns

Example

Response

Retrieve model

Parameters

Returns

Example

Response

Delete a fine-tuned model

Parameters

Returns

Example

Response

Domain Types

Model

Model Deleted