Skip to content
API Reference
Uploads
Parts

Add upload part

uploads.parts.create(upload_id, **kwargs) -> UploadPart { id, created_at, object, upload_id }
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.

ParametersExpand Collapse
upload_id: String
data: FileInput

The chunk of bytes for this Part.

ReturnsExpand Collapse
class UploadPart { id, created_at, object, upload_id }

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_id: String

The ID of the Upload object that this Part was added to.

Add upload part

require "openai"

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

upload_part = openai.uploads.parts.create("upload_abc123", data: Pathname(__FILE__))

puts(upload_part)
{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}