Uploads

Create upload

Changed on

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.

post/uploads

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/uploads
  • Auth
    HTTP bearer

Request body

filenamestring required

The name of the file to upload.

purpose'assistants' | 'batch' | 'fine-tune' | 'vision' required

The intended purpose of the uploaded file.

See the documentation on File purposes.

bytesinteger required

The number of bytes in the file you are uploading.

mime_typestring 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

OK

idstring required

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

created_atinteger required

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

filenamestring required

The name of the file to be uploaded.

bytesinteger required

The intended number of bytes to be uploaded.

purposestring required

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

status'pending' | 'completed' | 'cancelled' | 'expired' required

The status of the Upload.

expires_atinteger required

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

object'upload'

The object type, which is always "upload".

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7eddcd50e394Revision changes
    • breaking

      the response property // became nullable for the status