Uploads

Create upload

uploads.create(**kwargs) -> Upload

post /uploads

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purpose values, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case.

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

Returns the Upload object with status pending.

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.
- :assistants
- :batch
- :"fine-tune"
- :vision
- :user_data
- :evals
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: :assistants)

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"
  }
}

Complete upload

uploads.complete(upload_id, **kwargs) -> Upload

post /uploads/{upload_id}/complete

Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status completed, including an additional file property containing the created usable File object.

Parameters

upload_id: String
part_ids: Array[String]

The ordered list of Part IDs.
md5: String

The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

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.complete("upload_abc123", part_ids: ["string"])

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"
  }
}

Cancel upload

uploads.cancel(upload_id) -> Upload

post /uploads/{upload_id}/cancel

Cancels the Upload. No Parts may be added after an Upload is cancelled.

Returns the Upload object with status cancelled.

Parameters

upload_id: String

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.cancel("upload_abc123")

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"
  }
}

Domain Types

Upload

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.

Parts

Add upload part

uploads.parts.create(upload_id, **kwargs) -> UploadPart

post /uploads/{upload_id}/parts

Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.

Parameters

upload_id: String
data: String

The chunk of bytes for this Part.

Returns

class UploadPart

The upload Part represents a chunk of bytes we can add to an Upload object.
- id: String
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- created_at: Integer
  
  The Unix timestamp (in seconds) for when the Part was created.
- object: :"upload.part"
  
  The object type, which is always upload.part.
  - :"upload.part"
- upload_id: String
  
  The ID of the Upload object that this Part was added to.

Example

require "openai"

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

upload_part = openai.uploads.parts.create("upload_abc123", data: StringIO.new("Example data"))

puts(upload_part)

Response

{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}

Domain Types

Upload Part

class UploadPart

The upload Part represents a chunk of bytes we can add to an Upload object.
- id: String
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- created_at: Integer
  
  The Unix timestamp (in seconds) for when the Part was created.
- object: :"upload.part"
  
  The object type, which is always upload.part.
  - :"upload.part"
- upload_id: String
  
  The ID of the Upload object that this Part was added to.

ruby/resources/uploads/index.md +48 −5

6 6

7**post** `/uploads`7**post** `/uploads`

8 8

~~9Create upload~~9Creates an intermediate [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object

10that you can add [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.

11Currently, an Upload can accept at most 8 GB in total and expires after an

12hour after you create it.

14Once you complete the Upload, we will create a

15[File](https://platform.openai.com/docs/api-reference/files/object) object that contains all the parts

16you uploaded. This File is usable in the rest of our platform as a regular

17File object.

19For certain `purpose` values, the correct `mime_type` must be specified.

20Please refer to documentation for the

21[supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).

23For guidance on the proper filename extensions for each purpose, please

24follow the documentation on [creating a

25File](https://platform.openai.com/docs/api-reference/files/create).

27Returns the Upload object with status `pending`.

10 28

11### Parameters29### Parameters

12 30

32 See the [documentation on File50 See the [documentation on File

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

34 52

53 - `:assistants`

55 - `:batch`

57 - `:"fine-tune"`

59 - `:vision`

61 - `:user_data`

63 - `:evals`

35- `expires_after: ExpiresAfter{ anchor, seconds}`65- `expires_after: ExpiresAfter{ anchor, seconds}`

36 66

37 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.67 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.

165 195

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

167 197

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

169 199

170puts(upload)200puts(upload)

171```201```

202 232

203**post** `/uploads/{upload_id}/complete`233**post** `/uploads/{upload_id}/complete`

204 234

205Complete upload235Completes the [Upload](https://platform.openai.com/docs/api-reference/uploads/object).

236

237Within the returned Upload object, there is a nested [File](https://platform.openai.com/docs/api-reference/files/object) object that is ready to use in the rest of the platform.

238

239You can specify the order of the Parts by passing in an ordered list of the Part IDs.

240

241The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.

242Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.

206 243

207### Parameters244### Parameters

208 245

372 409

373**post** `/uploads/{upload_id}/cancel`410**post** `/uploads/{upload_id}/cancel`

374 411

375Cancel upload412Cancels the Upload. No Parts may be added after an Upload is cancelled.

413

414Returns the Upload object with status `cancelled`.

376 415

377### Parameters416### Parameters

378 417

650 689

651**post** `/uploads/{upload_id}/parts`690**post** `/uploads/{upload_id}/parts`

652 691

653Add upload part692Adds a [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload.

693

694Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

695

696It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).

654 697

655### Parameters698### Parameters

656 699

ruby/resources/uploads/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Uploads

Create upload

Parameters

Returns

Example

Response

Complete upload

Parameters

Returns

Example

Response

Cancel upload

Parameters

Returns

Example

Response

Domain Types

Upload

Parts

Add upload part

Parameters

Returns

Example

Response

Domain Types

Upload Part