API Reference

Uploads

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create upload

uploads.create(UploadCreateParams**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.

ParametersExpand Collapse

bytes: int

The number of bytes in the file you are uploading.

filename: str

The name of the file to upload.

mime_type: str

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: Optional[ExpiresAfter]

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.

ReturnsExpand Collapse

class Upload: …

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

id: str

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

bytes: int

The intended number of bytes to be uploaded.

created_at: int

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

formatunixtime

expires_at: int

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

formatunixtime

filename: str

The name of the file to be uploaded.

object: Literal["upload"]

The object type, which is always “upload”.

purpose: str

The intended purpose of the file. Please refer here for acceptable values.

status: Literal["pending", "completed", "cancelled", "expired"]

The status of the Upload.

file: Optional[FileObject]

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

Create upload

Python

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
upload = client.uploads.create(
    bytes=0,
    filename="filename",
    mime_type="mime_type",
    purpose="assistants",
)
print(upload.id)

{
  "id": "upload_abc123",
  "object": "upload",
  "bytes": 2147483648,
  "created_at": 1719184911,
  "filename": "training_examples.jsonl",
  "purpose": "fine-tune",
  "status": "pending",
  "expires_at": 1719127296
}

Returns Examples

{
  "id": "upload_abc123",
  "object": "upload",
  "bytes": 2147483648,
  "created_at": 1719184911,
  "filename": "training_examples.jsonl",
  "purpose": "fine-tune",
  "status": "pending",
  "expires_at": 1719127296
}