Uploads

Cancel upload

Changed on

Cancels the Upload. No Parts may be added after an Upload is cancelled.

Returns the Upload object with status cancelled.

post/uploads/{upload_id}/cancel

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/uploads/{upload_id}/cancel
  • Auth
    HTTP bearer

Path parameters

upload_idstring required
Example:upload_abc123

The ID of the Upload.

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

    • 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