Create upload - OpenAI API

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 purposes, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case:

Assistants

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

Body Params application/json

purpose

string

required

The name of the file to upload.

filename

string

required

The intended purpose of the uploaded file.

See the documentation on File purposes.

bytes

integer

required

The number of bytes in the file you are uploading.

mime_type

string

required

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.

Example

null

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

string

required

object

string

required

bytes

integer

required

created_at

integer

required

filename

string

required

purpose

string

required

status

string

required

expires_at

integer

required

Example

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