Complete an upload

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.

POST /uploads/{upload_id}/complete

Complete an upload

cURL

curl --request POST \
  --url https://api.openai.com/v1/uploads/{upload_id}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "part_ids": [
    "<string>"
  ],
  "md5": "<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.

Path Parameters

upload_id · string · required

The ID of the Upload.

Example:

"upload_abc123"

Body

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.

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