Complete upload
$ openai uploads complete
post /uploads/{upload_id}/complete
Completes the Upload.
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Returns the Upload object with status completed, including an additional file property containing the created usable File object.
Parameters
-
--upload-id: stringThe ID of the Upload.
-
--part-id: array of stringThe ordered list of Part IDs.
-
--md5: optional stringThe optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
Returns
-
upload: object { id, bytes, created_at, 6 more }The Upload object can accept byte chunks in the form of Parts.
-
id: stringThe Upload unique identifier, which can be referenced in API endpoints.
-
bytes: numberThe intended number of bytes to be uploaded.
-
created_at: numberThe Unix timestamp (in seconds) for when the Upload was created.
-
expires_at: numberThe Unix timestamp (in seconds) for when the Upload will expire.
-
filename: stringThe name of the file to be uploaded.
-
object: "upload"The object type, which is always "upload".
-
purpose: stringThe intended purpose of the file. Please refer here for acceptable values.
-
status: "pending" or "completed" or "cancelled" or "expired"The status of the Upload.
-
"pending" -
"completed" -
"cancelled" -
"expired"
-
-
file: optional object { id, bytes, created_at, 6 more }The
Fileobject represents a document that has been uploaded to OpenAI.-
id: stringThe file identifier, which can be referenced in the API endpoints.
-
bytes: numberThe size of the file, in bytes.
-
created_at: numberThe Unix timestamp (in seconds) for when the file was created.
-
filename: stringThe name of the file.
-
object: "file"The object type, which is always
file. -
purpose: "assistants" or "assistants_output" or "batch" or 5 moreThe intended purpose of the file. Supported values are
assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-results,vision, anduser_data.-
"assistants" -
"assistants_output" -
"batch" -
"batch_output" -
"fine-tune" -
"fine-tune-results" -
"vision" -
"user_data"
-
-
status: "uploaded" or "processed" or "error"Deprecated. The current status of the file, which can be either
uploaded,processed, orerror.-
"uploaded" -
"processed" -
"error"
-
-
expires_at: optional numberThe Unix timestamp (in seconds) for when the file will expire.
-
status_details: optional stringDeprecated. For details on why a fine-tuning training file failed validation, see the
errorfield onfine_tuning.job.
-
-
Example
openai uploads complete \
--api-key 'My API Key' \
--upload-id upload_abc123 \
--part-id string
Response
{
"id": "id",
"bytes": 0,
"created_at": 0,
"expires_at": 0,
"filename": "filename",
"object": "upload",
"purpose": "purpose",
"status": "pending",
"file": {
"id": "id",
"bytes": 0,
"created_at": 0,
"filename": "filename",
"object": "file",
"purpose": "assistants",
"status": "uploaded",
"expires_at": 0,
"status_details": "status_details"
}
}