| name | box-sdk |
| description | Use this skill when working with the Box API, Box Content Cloud, or Box Node SDK (v10/v4). This includes file/folder operations, authentication (OAuth 2.0, JWT, Client Credentials, Developer Token), uploads, downloads, metadata, collaborations, and any Box platform integration tasks. Trigger when the user mentions Box, Box API, Box SDK, or box-node-sdk. |
| model | us.anthropic.claude-sonnet-4-5-20250929-v1:0 |
Box Node SDK v10
When to Use
Use this skill when:
- Working with the Box API or Box Content Cloud
- Building integrations that interact with Box (files, folders, users, metadata, collaborations, etc.)
- Authenticating with Box (OAuth 2.0, JWT, Client Credentials, Developer Token)
- Uploading, downloading, or managing files/folders in Box
- Using Box platform features (search, events, webhooks, sign requests, retention policies, etc.)
- The user mentions Box, Box API, Box SDK, or
box-node-sdk
Do NOT use this skill for:
- General Node.js questions unrelated to Box
- Other cloud storage providers (Google Drive, Dropbox, OneDrive, etc.)
Package Info
Version Guidance
| Scenario | Version | Install |
|---|
| New application | v10 | npm install box-node-sdk@10 |
Migrating from box-typescript-sdk-gen | v10 | npm install box-node-sdk@10 |
Existing app using both box-typescript-sdk-gen and box-node-sdk | v4 | npm install box-node-sdk@^4 |
Existing app on v3 of box-node-sdk | v4 | npm install box-node-sdk@^4 |
Authentication Methods
The SDK supports multiple authentication methods:
- Developer Token (
BoxDeveloperTokenAuth) - For testing and development
- OAuth 2.0 - For user-authorized apps
- Client Credentials Grant - For server-to-server apps
- JSON Web Token (JWT) - For server-to-server apps with JWT assertion
Quick Start
const { BoxClient, BoxDeveloperTokenAuth } = require('box-node-sdk');
async function main(token) {
let auth = new BoxDeveloperTokenAuth({ token });
let client = new BoxClient({ auth });
let entries = (await client.folders.getFolderItems('0')).entries;
entries.forEach((entry) => console.log(entry));
}
main('YOUR_DEVELOPER_TOKEN');
Browser Usage
Include lib/bundle.js, then access classes via:
const { BoxClient, BoxDeveloperTokenAuth } = window['box-node-sdk'];
Works with modern browsers (ES6+) and frameworks like React, Angular, and Next.js.
Key Features
- Full Box API coverage
- Auto-generation for rapid API updates
- Embedded documentation in source code
- Convenience methods (chunk uploads, classification, etc.)
- Built-in authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking
- FIPS 140-2 compliance support (with OpenSSL 3.0)
Available Managers (via client.*)
The BoxClient object provides access to managers for Box resources:
client.folders - Folder operations (create, get, update, delete, list items)client.files - File operations (get, update, delete, copy)client.uploads - File uploads (including chunked uploads)client.downloads - File downloadsclient.search - Search across Box contentclient.users - User managementclient.groups - Group managementclient.collaborations - Sharing and collaborationclient.comments - File commentsclient.metadata - Metadata on files and foldersclient.tasks - Task assignmentsclient.webLinks - Web links / bookmarksclient.trashedFiles / client.trashedFolders - Trash operationsclient.sharedLinks - Shared link managementclient.retentionPolicies - Retention policiesclient.legalHoldPolicies - Legal hold policiesclient.events - Event streamsclient.webhooks - Webhook managementclient.signRequests - Box Sign requests
Resources
