Uploads

Complete an upload

POST /openai/v1/uploads/{upload_id}/complete

Creates an upload from the supplied request.

Path parameters

upload_id string required

The ID of the Upload.

Request Body

The request body.

Content-Type: application/json

part_ids string[] required

The ordered list of Part IDs.

md5 string

The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

Responses

The request has succeeded.

Body

Content-Type: application/json

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

purpose string required

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

status enum required

The status of the Upload.

pendingcompletedcancelledexpired

expires_at integer required

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

object enum

The object type, which is always "upload".

upload

file OpenAI.OpenAIFile | null

The ready File object after the Upload is completed.

id string required

The file identifier, which can be referenced in the API endpoints.

bytes integer | null required

The size of the file, in bytes. In a completed file upload response, this can be null when the file size is not yet available.

created_at integer required

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

expires_at integer

The Unix timestamp (in seconds) for when the file will expire. In a completed file upload response, this can be null when no expiry is set.

filename string required

The name of the file.

object enum required

The object type, which is always file.

file

purpose enum required

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.

assistantsassistants_outputbatchbatch_outputfine-tunefine-tune-resultsvisionuser_data

status enum required

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

uploadedprocessederror

status_details string

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job. Completed file upload responses can return null when these details are unset.