Manage Applications

    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.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    12345

    The unique identifier that represent 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

    stringin bodyoptional
    Project.mov

    The optional new name of new file

    integer / int64in bodyrequired
    104857600

    The total number of bytes of the file to be uploaded

    Response

    application/jsonUpload Session

    Returns a new upload session.

    application/jsonClient Error

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

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

    Request Example

    cURL
    curl -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
    file_name = 'test_file.pdf'
    upload_session = client.folder('22222').create_upload_session(file_size, file_name)
    print('Created upload session {0} with chunk size of {1} bytes'.format(upload_session.id, upload_session.part_size))

    Response Example

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