- List all pending collaborations for a user
- Retrieve details of a specific collaboration by its ID, including the collaborator (user or group), their role, the item (file or folder) they have access to, and the collaboration status. Use list_folder_collaborations or list_file_collaborations to find collaboration IDs.
- Add a collaborator (user or group) to a file or folder with a specific role (editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner). You can identify users by email (accessible_by.login) or user ID (accessible_by.id) — no need to look up the user ID first if you have their email. Cannot add the folder/file owner as a collaborator (returns 400). The is_access_only option is only supported for folder collaborations, not files. The expires_at option requires the enterprise admin to enable the "Automatically remove invited collaborators" setting.
- Update a collaboration's role or path visibility. Requires the authenticated user to be the folder owner, co-owner, or enterprise admin. Returns 403 if the user lacks permission to modify the collaboration.
- Remove a collaboration, revoking the user's or group's access to the shared file or folder. Requires the collaboration_id, which can be obtained from list_folder_collaborations or list_file_collaborations.
- List all file and folder collaborations for a specific group, showing what content the group has access to and with what role. Requires enterprise admin or co-admin permissions — having manage_groups scope alone is not sufficient, the authenticated user must also have admin-level privileges in the Box Admin Console.
- List all collaborations on a folder, showing which users and groups have access and their roles (editor, viewer, co-owner, etc.). Returns both pending and active collaborations. Use the collaboration_id from the response for update_collaboration or delete_collaboration operations.
- List all collaborations on a file, showing which users and groups have access and their roles. Returns both pending and active collaborations. Use the collaboration_id from the response for update_collaboration or delete_collaboration operations.
- Add a comment to a file
- Retrieve information about a comment
- Update a comment's message
- Remove a comment
- List user and enterprise events
- Retrieve information about a file
- Retrieve a thumbnail of a file
- Update a file's name, description, parent folder (to move it), shared link, tags, or lock status. To lock a file, provide a lock object with access='lock'. Unlocking is not supported through this action — to unlock a file, use the Box web UI or the Box API directly.
- Search Box for files, folders and web links by name or content.
- Remove the lock from a file so other users can move, rename or change it again.
- Delete a file and move it to trash
- Copy a file to another folder
- Retrieve a specific version of a file
- List all versions of a file
- Promote a previous file version to be the current version
- Restore a previously deleted file version from the file's version history. This does NOT restore files from the trash — use restore_file for that. Requires the file_id and the file_version_id of the deleted version (obtainable from list_file_versions). Only works on premium Box accounts that support version tracking.
- Delete a specific file version
- List all comments on a specific file by its file_id. Use list_folder_items first to find the file_id if you only have the filename. Returns comment text, author, creation date, and reply information.
- List tasks on a file
- Retrieve information about a file in trash
- Restore a file from trash
- Permanently delete a trashed file
- List items in a folder. Use folder_id "0" to list items in the root folder.
- Retrieve information about a folder
- Create a new folder
- Update a folder's information
- Delete a folder and move it to trash
- Copy a folder to another folder
- Retrieve information about a folder in trash
- Restore a folder from trash
- Permanently delete a trashed folder
- List all items in trash
- List all enterprise groups, optionally filtered by name prefix. Returns group IDs, names, and basic details. Use filter_term to search for groups whose name starts with a specific string. This is a read-only listing operation that requires manage_groups scope.
- Retrieve detailed information about a specific group by its ID, including name, description, invitability_level, and member_viewability_level. Requires admin-level permissions or group membership — note this requires stronger permissions than list_groups, which may succeed even when get_group returns 403.
- Create a new enterprise group with optional invitation and member visibility settings. Requires enterprise admin or co-admin role — the manage_groups OAuth scope alone is not sufficient, the authenticated user must have admin-level privileges in the Box Admin Console.
- Update a group's name, description, invitation settings, or member visibility. Requires enterprise admin or co-admin permissions — the authenticated user must have admin-level privileges, not just manage_groups scope.
- Permanently delete an enterprise group. This action cannot be undone. Requires enterprise admin or co-admin permissions.
- List all members of a specific group, including their user IDs, roles (member or admin), and membership IDs. The membership ID is needed for update_group_membership and remove_user_from_group operations.
- Add a user to an enterprise group as a member or admin. Requires enterprise admin or co-admin permissions. Provide the user ID and group ID as nested objects. Returns 403 if the authenticated account lacks admin-level privileges for group membership management.
- Update a user's membership in a group
- Remove a user from a group
- Get the current Box connection's unified credentials and identity.
- List unified groups in Box.
- Get a unified Box group by ID.
- List unified organizations in Box.
- Get a unified Box organization by ID.
- List unified resource types in Box.
- List unified resource users in Box.
- List unified roles in Box.
- Get a unified Box role by ID.
- List unified users in Box.
- Get a unified Box user by ID.
- Returns detailed information about the currently authenticated Box user. This tool provides comprehensive user profile data including basic identification, contact information, role details, and account settings. No input parameters are required as it retrieves information for the authenticated user making the request. This tool is essential for understanding the current user context, verifying authentication status, and obtaining user-specific information for personalization or access control purposes. It's particularly useful when building user-aware applications or when you need to identify the current user's permissions and organizational role. The response includes core user attributes such as ID, name, email, login, role, job title, and additional account details like space usage, language preferences, and timezone settings. <examples> Get current user information: <input> {} </input> </examples>
- Searches for folders by name within Box using keyword matching. This tool helps locate specific folders by their names and can be scoped to search within a particular parent folder. Returns basic folder information including ID, type, and name for each matching folder. The search performs a keyword-based match against folder names and can be limited to search within a specific ancestor folder. This is particularly useful for navigating complex folder structures, finding project folders, or locating organizational folders by name patterns. The tool uses Box's search API with folder type filtering, ensuring only folders (not files) are returned in results. Search results are limited to preserve performance and can be paginated using the limit parameter. **Date Range Filters:** Date range filters properties of the input schema: created_at_range, updated_at_range, deleted_at_range. Use comma-separated RFC3339 timestamps. **Format:** "start_date,end_date" where: - Omit start date to search all folders before end date: ",2023-12-31T23:59:59Z" - Omit end date to search from start date to the present: "2023-01-01T00:00:00Z," - Both dates for specific range: "2023-01-01T00:00:00Z,2023-12-31T23:59:59Z" <examples> Basic folder search: <input> {
"folder_name": "Project Documents",
"limit": 30
} </input> Search within specific parent folder: <input> {
"folder_name": "2024 Reports",
"ancestor_folder_id": "123456789",
"limit": 50
} </input> Search for folders with partial name match: <input> {
"folder_name": "Finance",
"limit": 20
} </input> Limited results search: <input> {
"folder_name": "Marketing Campaign",
"ancestor_folder_id": "987654321",
"limit": 10
} </input> Search in root directory and limit results by date: <input> {
"folder_name": "Shared Resources",
"created_at_range": "2023-01-01T00:00:00Z,2023-12-31T23:59:59Z"
} </input> </examples>
- Lists files, folders, and web links contained in a folder. Returns a paginated list of items with at least fields. Fields (id, type, name, etag) are always returned. Use folder_id "0" for the root folder. Supported fields include: id, type, name, etag, sequence_id, sha1, content_created_at, content_modified_at, created_at, created_by, modified_at, modified_by, owned_by, parent, path_collection, size, trashed_at, item_status, description, shared_link, classification, comment_count, disposition_at, expires_at, extension, has_collaborations, is_accessible_via_shared_link, is_associated_with_app_item, is_externally_owned, is_package, lock, metadata, permissions, representations, shared_link_permission_options, tags, uploader_display_name, version_number, watermark_info, file_version. <examples> Basic folder listing: <input> {
"folder_id": "0",
"limit": 50
} </input> List with specific fields: <input> {
"folder_id": "123456789",
"fields": ["id", "name", "type", "size", "modified_at", "created_by"],
"limit": 100
} </input> Paginated listing: <input> {
"folder_id": "987654321",
"fields": ["id", "name", "type", "path_collection"],
"limit": 30,
"offset": 60
} </input> </examples>
- Searches for files using keywords and supports metadata filters, file extension filtering (without dots), and field selection. Maps to Box's searchForContent API with comprehensive filtering capabilities. The response always includes core fields: id, name, description, type, and size. Each entry also includes `url` (Box web link for files and folders; web links use the API `url` when returned). The 'fields' parameter allows you to request additional fields beyond these core ones. All requested fields (core + additional) will be included in the API request and returned in the response. **Available Additional Fields:** fileVersion, sha1, contentCreatedAt, contentModifiedAt, createdAt, createdBy, modifiedAt, modifiedBy, ownedBy, parent, pathCollection, purgedAt, sharedLink, size, trashedAt, classification, commentCount, dispositionAt, expiresAt, extension, hasCollaborations, isAccessibleViaSharedLink, isAssociatedWithAppItem, isExternallyOwned, isPackage, lock, metadata, permissions, representations, sharedLinkPermissionOptions, tags, uploaderDisplayName, watermarkInfo **Date Range Filters:** Date range filters properties of the input schema: created_at_range, updated_at_range, deleted_at_range. Use comma-separated RFC3339 timestamps. **Format:** "start_date,end_date" where: - Omit start date to search all items before end date: ",2023-12-31T23:59:59Z" - Omit end date to search from start date to the present: "2023-01-01T00:00:00Z," - Both dates for specific range: "2023-01-01T00:00:00Z,2023-12-31T23:59:59Z" <examples> Basic keyword search (returns core fields only): <input> {
"query": "contract agreement",
"limit": 50
} </input> Advanced search with additional fields: <input> {
"query": "quarterly report",
"file_extensions": ["pdf", "docx"],
"ancestor_folder_id": "123456789",
"fields": ["createdAt", "modifiedAt", "size", "createdBy"]
} </input> Searching by date: <input> {
"query": "quarterly report",
"file_extensions": ["pdf", "docx"],
"ancestor_folder_id": "123456789",
"created_at_range”: "2023-01-01T00:00:00Z,2023-12-31T23:59:59Z",
"fields": ["createdAt"]
} </input> Search with metadata filters and additional fields: <input> {
"query": "invoice",
"file_extensions": ["pdf"],
"limit": 30,
"fields": ["contentCreatedAt", "pathCollection", "metadata"],
"mdfilters": [
{
"scope": "enterprise",
"templateKey": "invoiceTemplate",
"filters": {
"amount": {
"gt": 1000,
"lt": 5000
},
"status": "approved",
"department": "finance"
}
}
]
} </input> Multi-template metadata search with custom fields: <input> {
"query": "project document",
"fields": ["modifiedBy", "sharedLink", "tags", "permissions"],
"mdfilters": [
{
"scope": "enterprise",
"templateKey": "projectTemplate",
"filters": {
"priority": "high",
"deadline": {
"gt": "2024-01-01"
}
}
},
{
"scope": "global",
"templateKey": "reviewTemplate",
"filters": {
"reviewer": "[email protected]"
}
}
]
} </input> </examples> - Get the text content of a file from Box. Prefers the markdown representation (preserves document structure for better LLM use) and falls back to extracted text when markdown is not available. If neither representation is available or both are still pending, an error is returned. Using this tool is preferred over the ai_qa_single_file tool since it is faster and more efficient. Works for files with text representations such as PDFs, documents, spreadsheets, presentations, code, etc. Optional version_id reads a past version (GET /files/{file_id}/versions/{version_id}); omit it for the current version. Use list_file_versions to get version_id values. **Key Features:** - Markdown representation preferred (structure preserved for LLMs); fallback to extracted text - Optional version_id for a past file version - 50MB file size limit enforcement - Clear error messages for unsupported operations <examples> Extract text content from a file: {
"file_id": "123456789",
} Extract text content from a past file version: {
"file_id": "123456789",
"version_id": "987654321",
} <output> {
"content": [
{
"type": "text",
"text": "This is the extracted text content from the file..."
}
]
} </output> </examples>
- Lists all tasks associated with a specific file. This tool retrieves task information including task details, message, status, and completion rule, due date from the Box platform. Tasks in Box are used to assign work to users on files, allowing for collaboration and workflow management. This tool provides access to all tasks assigned to a particular file, helping with project management and task tracking. The response includes comprehensive task details such as task type, assignee information, due dates, completion status, and any associated comments or messages. <examples> List tasks for a file: <input> {
"file_id": "1234567890"
} </input> </examples>
- Gets comprehensive file information from Box. Returns essential fields by default (id, name, extension, createdBy, modifiedBy, createdAt, modifiedAt). Use 'fields' parameter to request additional properties. **Common useful fields:** size, description, tags, metadata, permissions, shared_link, parent, path_collection, file_version, sha1, lock, classification, comment_count, has_collaborations, representations, watermark_info, uploader_display_name, content_created_at, content_modified_at, item_status, expires_at, trashed_at. <examples> Basic file info: <input>{"file_id": "123456789"}</input> File with metadata and permissions: <input> {
"file_id": "987654321",
"fields": ["id", "name", "size", "permissions", "tags", "metadata", "shared_link"]
} </input> Detailed file analysis: <input> {
"file_id": "555666777",
"fields": ["id", "name", "description", "file_version", "sha1", "path_collection", "classification", "comment_count", "has_collaborations"]
} </input> </examples>
- Retrieves comprehensive information about a folder in Box. Returns essential fields by default (id, name, createdBy, modifiedBy, createdAt, modifiedAt). Use 'fields' parameter to request additional properties. **Common useful fields:** size, description, tags, metadata, permissions, shared_link, parent, path_collection, folder_upload_email, has_collaborations, allowed_invitee_roles, can_non_owners_invite, can_non_owners_view_collaborators, is_collaboration_restricted_to_enterprise, classification, allowed_shared_link_access_levels, content_created_at, content_modified_at, item_status, sync_state, watermark_info, trashed_at. **Note:** Only request 'item_collection' when the user explicitly asks for folder contents. Use 'list_folder_content_by_folder_id' for browsing folder items instead. <examples> Basic folder info: <input>{"folder_id": "123456789"}</input> Folder with permissions and collaboration settings: <input> {
"folder_id": "987654321",
"fields": ["id", "name", "size", "permissions", "can_non_owners_invite", "has_collaborations"]
} </input> Detailed folder analysis with settings: <input> {
"folder_id": "555666777",
"fields": ["id", "name", "description", "path_collection", "folder_upload_email", "allowed_invitee_roles", "classification", "shared_link", "tags"]
} </input> </examples>
- Lists all comments on a specific file. Returns a paginated list of comments with configurable fields. Default fields (id, type, message, created_by, created_at) are always returned, but you can specify additional fields as needed. Supported fields include: id, type, message, created_at, created_by, modified_at, tagged_message, and any other comment-related fields supported by the Box API. Use pagination parameters (limit/offset) to handle files with many comments efficiently. <examples> Basic file comments listing: <input> {
"file_id": "123456789",
"limit": 50
} </input> List with specific fields: <input> {
"file_id": "987654321",
"fields": ["id", "message", "created_at", "created_by", "modified_at"],
"limit": 100
} </input> Paginated comments listing: <input> {
"file_id": "555666777",
"fields": ["id", "type", "message", "tagged_message", "created_by"],
"limit": 25,
"offset": 50
} </input> </examples>
- Lists all collaborations for multiple files and folders in a single request. This tool efficiently aggregates collaboration information across different item types, making multiple API calls as needed and providing comprehensive results with error handling for items that cannot be accessed. The tool processes up to 10 items simultaneously, handling both files and folders. It returns detailed collaboration information including user details, roles, status, and timestamps. Partial failures are handled gracefully - if some items fail to load, the tool still returns collaborations for successful items along with error details for failed requests. <examples> Basic file collaboration listing: <input> {
"items": [
{ "id": "123456789", "type": "file" }
]
} </input> Single folder collaboration listing: <input> {
"items": [
{ "id": "987654321", "type": "folder" }
]
} </input> Multiple items for bulk analysis: <input> {
"items": [
{ "id": "111222333", "type": "file" },
{ "id": "444555666", "type": "file" },
{ "id": "777888999", "type": "folder" },
{ "id": "101112131", "type": "folder" }
]
} </input> </examples>
- Lists available Box metadata templates so you can discover scope and templateKey for search_files_metadata. Use this first to find templates, then get_metadata_template_schema to get field keys. Call with scope "enterprise" for your org's templates or "global" for Box global templates.
- Returns the schema for a metadata template. Shield template "securityClassification-6VMVochwUWo": option colorID is normalized from staticConfig (default Yellow=0). Palette: 0=Yellow, 1=Orange, 2=Red, 3=Purple, 4=LightBlue, 5=DarkBlue, 6=Green, 7=Grey.
- Searches for files using SQL-like metadata queries. Requires: from (e.g. enterprise_123456.templateKey from list_metadata_templates), fields (field keys from get_metadata_template_schema). ancestor_folder_id defaults to "0" (root) if omitted. Use list_metadata_templates and get_metadata_template_schema first to discover templates and field keys.
- Uploads a new file to Box. This tool creates a new file in Box using the provided text content. The file name including the extension must be provided and the extension must match the file content. Markdown uploads (e.g. .md) are regular text files like any other supported extension. A parent folder ID can optionally be provided to determine where the new file should be created. The metadata details of the newly uploaded file are returned in response. If a file already exists with the same name, the tool will return an error. **Key Features:** - File creation with text content - Supported file extensions: txt, md, boxnote, html, svg, xml, csv, json, js, ts, py, sh - If the file extension is invalid, a .txt file will be created **Important:** This tool can only accept text content, to upload binary files, use the `get_upload_url` tool instead. To create a Box Note (.boxnote), use the `create_box_note` tool instead. <examples> Upload a file to Box: {
"file_name": "example.md",
"file_content": "#This is my example markdown file",
"parent_folder_id": "0",
} <output> {
"content": [
{
"type": "text",
"text": "{"file_link": "https://example.app.box.com/file/123456789", "file_id": "123456789", "file_name": "example.md", "size": 100, "created_at": "2025-01-01T00:00:00Z"}"
}
]
} </output> </examples>
- Creates new folders in Box.
<examples>
Create folder in root:
<input>
{
"name": "Project Documents"
}
</input>
Create folder in specific parent:
<input>
{
"name": "Q4 Reports",
"parent_folder_id": "123456789"
}
</input>
</examples>
- Creates a new comment on a specific file. This tool allows you to add comments to files for collaboration, feedback, or documentation purposes. Comments are visible to all users with access to the file and can be used for team communication and file annotation. The message can include special characters, line breaks, and Unicode characters. The tool returns complete comment information including metadata about the comment creation, author, and timestamps. <examples> Basic file comment: <input> {
"file_id": "123456789",
"message": "This document looks good overall. Please review the financial projections in section 3."
} </input> Multi-line structured comment: <input> {
"file_id": "777888999",
"message": "Review Summary:\n\nContent: Excellent\nStructure: Well organized\nFormatting: Minor issues\nCitations: Missing sources\n\nOverall: Good work, please address the citations before final submission."
} </input> </examples>
- Copies an existing file to a destination folder in Box (see Box API Copy file). The source file is not modified. Provide `parent_folder_id` as the folder that will contain the new copy; use `"0"` for the user's root folder. The copy keeps the original file name, so the destination folder must not already contain an item with that name. To rename the copy, use the `update_file_properties` tool with the `file_id` returned by this tool. <examples> Copy a file into a folder: {
"file_id": "123456789",
"parent_folder_id": "987654321"
} Copy a file to the user's root folder: {
"file_id": "123456789",
"parent_folder_id": "0"
} </examples>
- Copies an existing folder to a destination parent folder in Box (see Box API Copy folder). The source folder is not modified. Provide `parent_folder_id` as the folder that will contain the new copy; use `"0"` for the user's root folder. The root folder (`folder_id` `"0"`) cannot be copied. The copy keeps the original folder name, so the destination folder must not already contain an item with that name. To rename the copy, use the `update_folder_properties` tool with the `folder_id` returned by this tool. <examples> Copy a folder into another folder: {
"folder_id": "123456789",
"parent_folder_id": "987654321"
} Copy a folder to the user's root: {
"folder_id": "123456789",
"parent_folder_id": "0"
} </examples>
- Creates a new enterprise metadata template. scope must be "enterprise"; each field needs type, key, and display_name. Optional template_key, hidden, copy_instance_on_item_copy, enum/multiSelect/taxonomy. Enum color_id optional (0=Yellow, 1=Orange, 2=Red, 3=Purple, 4=LightBlue, 5=DarkBlue, 6=Green, 7=Grey); omit for default Yellow (0). SDK create sends keys only; non-default colors are PATCHed after create when color_id is set. On success returns created template JSON (or JSON after color PATCH). If color PATCH fails, response still succeeds with colorApplyWarning. <examples> Minimal template with one string field: <input> {
"scope": "enterprise",
"display_name": "Sample contract template",
"template_key": "sampleContract",
"fields": [
{
"type": "string",
"key": "Name",
"display_name": "Name"
}
]
} </input> <output> {
"id": "f7a9891f",
"scope": "enterprise_12345",
"templateKey": "sampleContract",
"displayName": "Sample contract template",
"hidden": false,
"fields": [
{
"type": "string",
"key": "Name",
"displayName": "Name"
}
]
} </output> Enum field with classification colors (color_id optional per option): <input> {
"scope": "enterprise",
"display_name": "Data classes",
"template_key": "dataClasses",
"fields": [
{
"type": "enum",
"key": "tier",
"display_name": "Tier",
"options": [
{ "key": "Public", "color_id": 6 },
{ "key": "Internal", "color_id": 4 },
{ "key": "Restricted", "color_id": 2 }
]
}
]
} </input> </examples>
- Lists all hubs accessible to the current user with pagination support. Provides an overview of available collaborative workspaces and their basic information. Hubs in Box are collaborative workspaces that organize content around specific topics, projects, or teams. This tool helps discover what hubs you have access to, making it easy to find the right collaborative space for your work. **Key Features:** - Lists all accessible hubs for the authenticated user - Supports pagination with configurable limits and markers - Returns essential hub information including ID, type, and title - Efficient retrieval with adjustable result limits (1-1000) <examples> List all accessible hubs with default settings: <input> {
"limit": 50
} </input> List hubs with custom pagination: <input> {
"limit": 30,
"marker": "next_marker_from_previous_response"
} </input> </examples>
- Retrieves comprehensive information about a specific hub including metadata, creation details, and administrative information. Provides complete hub context for understanding ownership, timing, and purpose. This tool is essential for understanding hub context, ownership, and management information. It provides the complete picture of a hub's properties, helping users understand when it was created, by whom, and its current status. **Key Features:** - Retrieves detailed hub information including title, description, and metadata - Provides creation and modification timestamps - Shows hub ownership and creator information - Returns complete hub context for administrative and management purposes <examples> Get detailed information about a specific hub: <input> {
"hub_id": "12345"
} </input> </examples>
- Retrieves all items within a specific hub including files, folders, and web links. Essential for exploring the contents of collaborative workspaces and understanding what resources are available in a hub. This tool provides comprehensive access to hub contents with pagination support, allowing you to browse through all materials that have been added to a collaborative workspace. Perfect for content discovery and hub content management. **Key Features:** - Retrieves all items (files, folders, web links) within a specific hub - Supports pagination for hubs with large amounts of content - Returns detailed item information including names, types, and IDs - Configurable result limits for efficient data retrieval <examples> Get items in a specific hub: <input> {
"hub_id": "12345"
} </input> Get hub items with pagination: <input> {
"hub_id": "67890",
"limit": 50,
"marker": "next_marker_value"
} </input> Get first 25 items from a hub: <input> {
"hub_id": "11111",
"limit": 25
} </input> </examples>
- Creates new collaborative hubs for organizing content around specific topics, projects, or teams. Enables the establishment of new collaborative workspaces with customizable titles and descriptions. This tool is essential for setting up new collaborative spaces where teams can organize, share, and work together on related content. Hubs serve as central gathering points for all materials related to a particular initiative or project. **Key Features:** - Creates new hubs with custom titles and optional descriptions - Establishes collaborative workspaces for team projects - Returns complete hub information upon successful creation - Supports both minimal (title-only) and detailed hub creation <examples> Create a simple hub with title only: <input> {
"title": "Marketing Team Hub"
} </input> </examples>
- Adds files, folders, or web links to a specific hub, enabling content organization within collaborative workspaces. Essential for building and curating hub content by adding relevant materials to the collaborative space. This tool enables the population of hubs with relevant content, making it easy to organize materials within collaborative workspaces. You can add multiple items at once, supporting efficient hub content management and organization. **Key Features:** - Adds multiple items (files, folders, web links) to hubs in a single operation - Supports batch operations for efficient content organization - Works with all Box content types: files, folders, and web links - Provides confirmation of successful additions with detailed results **Supported Item Types:** - `file`: Box files of any type - `folder`: Box folders and their contents - `web_link`: External web links and bookmarks <examples> Add a single file to a hub: <input> {
"hub_id": "12345",
"items": [
{"id": "98765", "type": "file"}
]
} </input> Add multiple items to a hub: <input> {
"hub_id": "12345",
"items": [
{"id": "98765", "type": "file"},
{"id": "54321", "type": "folder"},
{"id": "11111", "type": "web_link"}
]
} </input> Add resources to a team hub: <input> {
"hub_id": "55555",
"items": [
{"id": "111111", "type": "folder"},
{"id": "222222", "type": "web_link"},
{"id": "333333", "type": "file"}
]
} </input> </examples>
- Creates a copy of an existing Box Hub via the Hubs v3 API (`POST /v3/hubs/{id}:copy`). The source hub is not modified. Copies the source hub's description (unless overridden) and shareable items into the new hub by setting `includeItems` to `true`. **Important:** Only items the user has permission to share into the new hub are copied. Items the user can view only through the hub itself (without share permission) are not copied. **hub_id** (required): The source hub to copy. Use `list_hubs` to find hubs and match by `title` to obtain the `id`, or take the id from the hub URL (`/hubs/{id}`). **title** (optional): Title for the new hub (max 50 characters). **description** (optional): Description for the new hub. When omitted, the source hub description is copied. <examples> Copy a hub, supplying a new title: {
"hub_id": "12345",
"title": "Research hub (copy)"
} Copy using only the hub id (minimal body): {
"hub_id": "12345"
} </examples>
- Creates a new Box Note in Box from markdown content. A Box Note is Box's native collaborative document format (.boxnote). The note name must be provided; the .boxnote extension is optional and will be appended if missing. **Key Features:** - Creates a native Box Note from markdown content - Use this tool instead of `upload_file` whenever the desired output is a Box Note **Important:** This tool only creates Box Notes. To create other text files (e.g. .txt, .md), use the `upload_file` tool instead.
- Displays an interactive preview widget for a Box file directly in chat. Supports: ai, bmp, cr2, crw, csv, dng, doc, docx, dwg, eml, eps, gdoc, gif, gsheet, gslide, gslides, heic, htm, html, idml, indd, indt, inx, jpeg, jpg, key, nef, numbers, odp, ods, odt, pages, pdf, png, ppt, pptx, ps, psd, raf, raw, rtf, svg, svs, tga, tif, tiff, tsv, webp, wpd, xhtml, xls, xlsm, xlsx. PDF uses direct download; other types use the appropriate representation (e.g. PDF for documents, JPG/PNG for images). Use when user wants to view file contents without downloading. For file metadata, use get_file_info instead. If the preview payload would exceed 3MB (full file for PDFs; generated representation for other types), do not use this. Do not attempt to generate an interactive artifact. When a preview is open, the widget sends file preview context (fileId, fileName, currentPage) into the conversation. If the user asks about "this graph", "explain this", "what's on this page", or similar, look for that context and call get_preview_page(fileId, currentPage) to fetch the page image—do not ask the user which page they are on.
- Use when user asks follow-up question to a file previewed with get_file_preview ("Explain this...", "What does ____ mean?")Returns the current preview page as an image so you can analyze it (figures, text, charts, etc.). You cannot see the page content until you call this tool. Required workflow: 1. Find the file preview context in the conversation. The preview widget sends it as content like: "Current file preview: fileId=123, fileName=doc.pdf, currentPage=3. Use get_preview_page with this fileId and currentPage...". Look for this before calling. 2. Extract fileId and currentPage from that context. If the user asks about "this page", "these figures", "what's on the page", use currentPage from the context. If they name a page (e.g. "page 7"), use that number instead. 3. Call get_preview_page(fileId, currentPage) to fetch the page image. You must call this tool to see the page—there is no other way to view its content. 4. Use the returned image to answer the user's question. Do not call with a fileId or page from elsewhere. If no file preview context is present (no "Current file preview: fileId=..." in the conversation), do not call. Supported extensions: ai, bmp, cr2, crw, csv, dng, doc, docx, dwg, eml, eps, gdoc, gif, gsheet, gslide, gslides, heic, htm, html, idml, indd, indt, inx, jpeg, jpg, key, nef, numbers, odp, ods, odt, pages, pdf, png, ppt, pptx, ps, psd, raf, raw, rtf, svg, svs, tga, tif, tiff, tsv, webp, wpd, xhtml, xls, xlsm, xlsx.
- List all metadata instances on a file
- Retrieve a specific metadata instance on a file
- Apply a metadata template instance to a file. Requires the file_id, scope (e.g. 'enterprise_1452824910' or 'global'), template_key, and a metadata object with field values. Even if all template fields are optional, the metadata object must contain at least one key-value pair — an empty object {} is rejected with 400 Bad Request. Returns 409 Conflict if this template is already applied to the file (use update_file_metadata to modify existing metadata).
- Update a metadata instance on a file
- Remove a metadata instance from a file
- Retrieve a specific metadata instance on a folder
- List all metadata instances on a folder
- Apply a metadata template instance to a folder. Requires the folder_id, scope, template_key, and a metadata object with at least one key-value pair. Returns 409 Conflict if this template is already applied to the folder — use update_folder_metadata to modify existing metadata, or delete_folder_metadata first to remove and re-apply.
- Update a metadata instance on a folder
- Remove a metadata instance from a folder
- Create an enterprise metadata template that can then be applied to files and folders.
- List all metadata templates
- Retrieve a metadata template
- Search for files and folders that have specific metadata values applied. This is a read-only search/query tool — it does NOT create, update, or delete metadata. Use create_file_metadata, update_file_metadata, or delete_file_metadata for write operations. Uses SQL-like syntax to filter by metadata field values.
- Create a review or completion task on a file. The task is created unassigned — use assign_task afterwards to assign it to users. Accepts an optional due date in ISO 8601 format (e.g. "2025-12-31T23:59:00+00:00"). Use +00:00 for UTC timezone offset, not -00:00.
- Retrieve information about a task
- Update a task's message, due date, action type, or completion rule. Every update body must include message, so pair it with any other field being changed. Assign at least one user before changing completion_rule.
- Remove a task
- List assignments for a task
- Assign a task to a user by user ID or email address. The user receives a notification. You can use either assign_to.id (user ID) or assign_to.login (email address) — you do not need to look up the user ID first if you already have their email.
- Retrieve information about a task assignment
- Update a task assignment's resolution state or message. For review-type tasks, resolution_state (approved or rejected) is required — sending only a message without resolution_state returns 403. Only the task creator, the assignee, or enterprise admins can update an assignment.
- Remove a task assignment
- Upload a new file
- Upload a new version of an existing file by providing the file_id, base64-encoded file content (file_content), and a filename (file_name). All three parameters are required. For files up to 50MB only — use chunked upload for larger files.
- Create a chunked upload session for large files
- Retrieve the profile of the currently authenticated user, including their user ID, name, email, avatar URL, and enterprise info. Does not require admin permissions — any authenticated user can call this. Use this to get the current user's ID when you need it for other operations.
- List all enterprise users with their IDs, names, and email addresses. Requires enterprise admin or co-admin permissions with manage_managed_users scope. Use filter_term to search by name or email prefix. Use user_type to filter by managed, external, or all users. If you already have a user's email address (e.g. for task assignment), you can pass it directly to assign_task via assign_to.login instead of looking up their user ID here.
- Retrieve information about a user
- Create a new managed user account in the enterprise. Requires enterprise admin or co-admin role with manage_managed_users scope. The login email must use a real domain (not @example.com). Returns 403 Forbidden if the authenticated account lacks admin privileges.
- Update a user's information
- Delete a user from the enterprise
- Retrieve a user's avatar image. Returns 404 if no custom avatar has been uploaded, even when the user profile contains an avatar_url field (which points to a default placeholder until a real image is uploaded). Use this to check whether a user has a custom profile picture.
- Delete a user's avatar image
- Retrieve all webhooks for the authenticated application
- Retrieve a specific webhook by ID
No matching actions