Sign in

v36

OpenAPI 3.1.0raw.githubusercontent.com2026-05-13002.7 MB
Uploads

Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) 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.

post/uploads/{upload_id}/complete

Path parameters

upload_idstring required
Example:upload_abc123

The ID of the Upload.

Request body

part_idsstring[] required

The ordered list of Part IDs.

md5string

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

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".