Uploads

Cancel upload

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

Path parameters

upload_idstring required

Example:upload_abc123

The ID of the Upload.

Response

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

Changed in 9 of the 164 revisions of this API.17325

Sep 25, 2026cda988e2e3644See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
May 13, 202674cbcf73838f1See the full diff
- ●
  added the new user_data enum value to the // response property for the response status
  response-property-enum-value-added
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 11, 20256ab43fe7798e1See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jan 31, 2025fc164a27fdb9711See the full diff
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
Jan 31, 202515156e46769c19See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
Jan 22, 2025bdebcdfcbbde711See the full diff
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
Jul 19, 2024837775c0b9881See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
Jul 19, 202446964092fbe11See the full diff
- ○
  the response property became required for the status
  response-property-became-required
Jul 18, 2024bddc980d3fbb18See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added

Full history