API Reference

Uploads

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create upload

uploads.create(**kwargs) -> Upload { id, bytes, created_at, 6 more }

POST/uploads

Create upload

ParametersExpand Collapse

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.

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).

formatint64

minimum3600

maximum2592000

ReturnsExpand Collapse

class Upload { id, bytes, created_at, 6 more }

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.

formatunixtime

expires_at: Integer

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

formatunixtime

filename: String

The name of the file to be uploaded.

object: :upload

The object type, which is always “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.

One of the following:

:pending

:completed

:cancelled

:expired

file: FileObject { id, bytes, created_at, 6 more }

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.

formatunixtime

filename: String

The name of the file.

object: :file

The object type, which is always 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.

One of the following:

:assistants

:assistants_output

:batch

:batch_output

:"fine-tune"

:"fine-tune-results"

:vision

:user_data

Deprecatedstatus: :uploaded | :processed | :error

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

One of the following:

:uploaded

:processed

:error

expires_at: Integer

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

formatunixtime

Deprecatedstatus_details: String

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

Create upload

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

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)

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