ruby/resources/uploads/methods/create/index.md

Create upload

uploads.create(**kwargs) -> Upload

post /uploads

Create upload

Parameters

bytes: Integer

The number of bytes in the file you are uploading.
filename: String

The name of the file to upload.
mime_type: String

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.
purpose: FilePurpose

The intended purpose of the uploaded file.

See the documentation on File purposes.
expires_after: ExpiresAfter{ anchor, seconds}

The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.
- anchor: :created_at
  
  Anchor timestamp after which the expiration policy applies. Supported anchors: created_at.
  - :created_at
- seconds: Integer
  
  The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

Returns

class Upload

The Upload object can accept byte chunks in the form of Parts.
- id: String
  
  The Upload unique identifier, which can be referenced in API endpoints.
- bytes: Integer
  
  The intended number of bytes to be uploaded.
- created_at: Integer
  
  The Unix timestamp (in seconds) for when the Upload was created.
- expires_at: Integer
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- filename: String
  
  The name of the file to be uploaded.
- object: :upload
  
  The object type, which is always "upload".
  - :upload
- purpose: String
  
  The intended purpose of the file. Please refer here for acceptable values.
- status: :pending | :completed | :cancelled | :expired
  
  The status of the Upload.
  - :pending
  - :completed
  - :cancelled
  - :expired
- file: FileObject
  
  The File object represents a document that has been uploaded to OpenAI.
  - id: String
    
    The file identifier, which can be referenced in the API endpoints.
  - bytes: Integer
    
    The size of the file, in bytes.
  - created_at: Integer
    
    The Unix timestamp (in seconds) for when the file was created.
  - filename: String
    
    The name of the file.
  - object: :file
    
    The object type, which is always file.
    - :file
  - purpose: :assistants | :assistants_output | :batch | 5 more
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - :assistants
    - :assistants_output
    - :batch
    - :batch_output
    - :"fine-tune"
    - :"fine-tune-results"
    - :vision
    - :user_data
  - status: :uploaded | :processed | :error
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - :uploaded
    - :processed
    - :error
  - expires_at: Integer
    
    The Unix timestamp (in seconds) for when the file will expire.
  - status_details: String
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

require "openai"

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

upload = openai.uploads.create(bytes: 0, filename: "filename", mime_type: "mime_type", purpose: {})

puts(upload)

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  }
}

ruby/resources/uploads/methods/create/index.md +195 −0 created

1## Create upload

3`uploads.create(**kwargs) -> Upload`

5**post** `/uploads`

7Create upload

9### Parameters

11- `bytes: Integer`

13 The number of bytes in the file you are uploading.

15- `filename: String`

17 The name of the file to upload.

19- `mime_type: String`

21 The MIME type of the file.

23 This must fall within the supported MIME types for your file purpose. See

24 the supported MIME types for assistants and vision.

26- `purpose: FilePurpose`

28 The intended purpose of the uploaded file.

30 See the [documentation on File

31 purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).

33- `expires_after: ExpiresAfter{ anchor, seconds}`

35 The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted.

37 - `anchor: :created_at`

39 Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.

41 - `:created_at`

43 - `seconds: Integer`

45 The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

47### Returns

49- `class Upload`

51 The Upload object can accept byte chunks in the form of Parts.

53 - `id: String`

55 The Upload unique identifier, which can be referenced in API endpoints.

57 - `bytes: Integer`

59 The intended number of bytes to be uploaded.

61 - `created_at: Integer`

63 The Unix timestamp (in seconds) for when the Upload was created.

65 - `expires_at: Integer`

67 The Unix timestamp (in seconds) for when the Upload will expire.

69 - `filename: String`

71 The name of the file to be uploaded.

73 - `object: :upload`

75 The object type, which is always "upload".

77 - `:upload`

79 - `purpose: String`

81 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

83 - `status: :pending | :completed | :cancelled | :expired`

85 The status of the Upload.

87 - `:pending`

89 - `:completed`

91 - `:cancelled`

93 - `:expired`

95 - `file: FileObject`

97 The `File` object represents a document that has been uploaded to OpenAI.

99 - `id: String`

100

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

102

103 - `bytes: Integer`

104

105 The size of the file, in bytes.

106

107 - `created_at: Integer`

108

109 The Unix timestamp (in seconds) for when the file was created.

110

111 - `filename: String`

112

113 The name of the file.

114

115 - `object: :file`

116

117 The object type, which is always `file`.

118

119 - `:file`

120

121 - `purpose: :assistants | :assistants_output | :batch | 5 more`

122

123 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

124

125 - `:assistants`

126

127 - `:assistants_output`

128

129 - `:batch`

130

131 - `:batch_output`

132

133 - `:"fine-tune"`

134

135 - `:"fine-tune-results"`

136

137 - `:vision`

138

139 - `:user_data`

140

141 - `status: :uploaded | :processed | :error`

142

143 Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.

144

145 - `:uploaded`

146

147 - `:processed`

148

149 - `:error`

150

151 - `expires_at: Integer`

152

153 The Unix timestamp (in seconds) for when the file will expire.

154

155 - `status_details: String`

156

157 Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`.

158

159### Example

160

161```ruby

162require "openai"

163

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

165

166upload = openai.uploads.create(bytes: 0, filename: "filename", mime_type: "mime_type", purpose: {})

167

168puts(upload)

169```

170

171#### Response

172

173```json

174{

175 "id": "id",

176 "bytes": 0,

177 "created_at": 0,

178 "expires_at": 0,

179 "filename": "filename",

180 "object": "upload",

181 "purpose": "purpose",

182 "status": "pending",

183 "file": {

184 "id": "id",

185 "bytes": 0,

186 "created_at": 0,

187 "filename": "filename",

188 "object": "file",

189 "purpose": "assistants",

190 "status": "uploaded",

191 "expires_at": 0,

192 "status_details": "status_details"

193 }

194}

195```

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

Create upload

Parameters

Returns

Example

Response