Skip to main content
The Chunked Upload API provides a way to reliably upload large files to Box by chunking them into a sequence of parts that can be uploaded individually. By using this API the application uploads a file in parts, allowing it to recover from a failed request more reliably. It means an application only needs to retry the upload of a single part instead of the entire file. An additional benefit of chunked uploads is that parts can be uploaded in parallel, allowing for a potential performance improvement.

Overview

Chunked uploads require a sequence of API calls to be made.
  1. : The application creates an upload session for a new file or new version of a file. The session defines the (new) name of the file, its size, and the parent folder.
  2. (optional): When uploading a new version of a file, the application sends the offset, size, and SHA-512 hash of each part. Box returns the parts it already stores, so the application can skip them.
  3. : The application uploads the separate parts of the file as chunks. If the application planned the session, it only uploads the parts Box doesn’t already store.
  4. : The application commits the session, at which moment the integrity of the file is checked before it is placed in the location specified when the session was created.
Most of out of the Box, removing the complexity from the application code.

Skip parts Box already stores

A new version of a large file often shares most of its content with the previous version. Instead of uploading every part, you can plan the upload session first, so that you only upload the parts that changed. Planning is optional. For details on the plan request and response, see the .
Box only reuses parts from the previous version of the same file, and only when the user uploading the file has permission to download that version.

Restrictions

The Chunked Upload API is intended for large files with a minimum size of 20MB. The API does not support uploads of files with a size smaller than this. This API does not support re-uploading or overwriting of parts in a session. Once a part has been uploaded, it is immutable. The lifetime of an upload session is 7 days. During this time, the client can upload parts at their own pace. To avoid wasting resources, and avoid potential data corruption, the client should make sure that the underlying file has not been changed on disk since beginning the upload.
Last modified on October 26, 2026