Download file
Returns the contents of a file in binary format.
Request
Path Parameters
12345The 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.
Query Parameters
4The file version to download
Request Headers
shared_link=[link]The URL and password for a file that has been shared using a shared link, as this file would otherwise not be accessible to the user.
Use the format shared_link=SHARED_LINK_URL or if a password was set
use shared_link=[link]&shared_link_password=[password]
0-1024The byte range of the content to download.
The format {start_byte}-{end_byte} can be used to specify
what section of the file to download.
Response
If the file is not ready to be downloaded yet Retry-After header will
be returned indicating the time in seconds after which the file will
be available for the client to download.
This response can occur when the file was uploaded immediately before the download request.
If the file is available to be downloaded the response will include a
Location header for the file on dl.boxcloud.com.
The dl.boxcloud.com URL is not persistent and clients will need
to follow the redirect in order to actually download the file.
An unexpected client error.
Request Example
curl -X GET https://api.box.com/2.0/files/12345/content \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
-LStream fileContents = await client.FilesManager.DownloadStreamAsync(id: "11111");BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();
FileOutputStream stream = new FileOutputStream(info.getName());
file.download(stream);
stream.close();file_id = '11111'
file_content = client.file(file_id).content()var fs = require('fs');
client.files.getReadStream('12345', null, function(error, stream) {
if (error) {
// handle error
}
// write the file to disk
var output = fs.createWriteStream('/path/to/file');
stream.pipe(output);
});let url = FileManager.default.homeDirectoryForCurrentUser
let task: BoxDownloadTask = client.files.download(fileId: "11111", destinationURL: url) { (result: Result<Void, BoxSDKError>) in
guard case .success = result else {
print("Error downloading file")
return
}
print("File downloaded successfully")
}
// To cancel download
if someConditionIsSatisfied {
task.cancel()
}