Create upload

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.

POST /uploads

Create upload

cURL

curl --request POST \
  --url https://api.openai.com/v1/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "<string>",
  "purpose": "assistants",
  "bytes": 123,
  "mime_type": "<string>"
}
'

200

{
  "id": "<string>",
  "created_at": 123,
  "filename": "<string>",
  "bytes": 123,
  "purpose": "<string>",
  "status": "pending",
  "expires_at": 123,
  "object": "upload",
  "file": {
    "id": "<string>",
    "bytes": 123,
    "created_at": 123,
    "filename": "<string>",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 123,
    "status_details": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

filename · string · required

The name of the file to upload.

purpose · enum<string> · required

The intended purpose of the uploaded file.

See the documentation on File purposes.

Available options: assistants, batch, fine-tune, vision

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.

Response

200 - application/json

OK

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

id · string · required

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

created_at · integer · required

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

filename · string · required

The name of the file to be uploaded.

bytes · integer · required

The intended number of bytes to be uploaded.

purpose · string · required

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

status · enum<string> · required

The status of the Upload.

Available options: pending, completed, cancelled, expired

expires_at · integer · required

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

object · enum<string>

The object type, which is always "upload".

Available options: upload

file · OpenAIFile · object

The ready File object after the Upload is completed.

Show child attributes