Join BoxWorks 2024 to discover what's possible with content and AI!

Create upload session for existing file

post

https://upload.box.com/api/2.0

/files/:file_id/upload_sessions

Creates an upload session for an existing file.

Related Guides

Uploads Create Upload Session

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Path Parameters

file_id stringin pathrequired

example12345

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Request Body

file_name stringin bodyoptional

example"Project.mov"

The optional new name of new file

file_size integer (int64)in bodyrequired

example104857600

The total number of bytes of the file to be uploaded

Response

201application/jsonUpload session

Returns a new upload session.

409application/jsonClient error

Returns an error if the file already exists, or if the account has run out of disk space.

defaultapplication/jsonClient error

An unexpected client error.

post

Create upload session for existing file

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X POST "https://upload.box.com/api/2.0/files/12345/upload_sessions" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "file_size": 104857600
     }'

Python

file_size = 26000000
upload_session = client.file('11111').create_upload_session(file_size)
print(f'Created upload session {upload_session.id} with chunk size of {upload_session.part_size} bytes')

Response Example

{
  "id": "F971964745A5CD0C001BBE4E58196BFD",
  "type": "upload_session",
  "num_parts_processed": 455,
  "part_size": 1024,
  "session_endpoints": {
    "abort": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
    "commit": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit",
    "list_parts": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts",
    "log_event": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log",
    "status": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
    "upload_part": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
  },
  "session_expires_at": "2012-12-12T10:53:43-08:00",
  "total_parts": 1000
}