Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) 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](/docs/api-reference/files/object) 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`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: - [Assistants](/docs/assistants/tools/file-search/supported-files) For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create).
POST /uploads
Authorizations
Request Body required
object
The name of the file to upload.
The intended purpose of the uploaded file.
See the documentation on File purposes.
The number of bytes in the file you are uploading.
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.
Responses
200
OK
The Upload object can accept byte chunks in the form of Parts.
object
The Upload unique identifier, which can be referenced in API endpoints.
The Unix timestamp (in seconds) for when the Upload was created.
The name of the file to be uploaded.
The intended number of bytes to be uploaded.
The intended purpose of the file. Please refer here for acceptable values.
The status of the Upload.
The Unix timestamp (in seconds) for when the Upload was created.
The object type, which is always “upload”.
The ready File object after the Upload is completed.
object
The file identifier, which can be referenced in the API endpoints.
The size of the file, in bytes.
The Unix timestamp (in seconds) for when the file was created.
The name of the file.
The object type, which is always file.
The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.
Deprecated. The current status of the file, which can be either uploaded, processed, or error.
Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.