Box

Learn how to use Box with Composio

Overview

SLUG: BOX

Description

Cloud content management and file sharing service for businesses.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.box.com/2.0Required
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
bearer_token
string

Connecting to Box

Create an auth config

Use the dashboard to create an auth config for the Box toolkit. This allows you to connect multiple Box accounts to Composio for agents to use.

1

Select App

Navigate to Box.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Box Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4box_auth_config_id = "ac_YOUR_BOX_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Box: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, box_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Box toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BOX"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create box sign request

Description

Creates a signature request. this involves preparing a document for signing and sending the signature request to signers.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create collaboration

Description

Adds a collaboration for a single user or a single group to a file or folder. collaborations can be created using email address, user ids, or a group ids. if a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited. if collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user id`, - `name` is hidden if a collaboration was created using `login`.

Action Parameters

accessible__by__id
string
accessible__by__login
string
accessible__by__type
string
can_view_path
boolean
expires_at
string
fields
array
is_access_only
boolean
item__id
string
item__type
string
notify
boolean
role
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create comment

Description

Adds a comment by the user to a specific file, or as a reply to an other comment.

Action Parameters

fields
array
item__id
string
item__type
string
message
stringRequired
tagged_message
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create folder

Description

Creates a new empty folder within the specified parent folder.

Action Parameters

fields
array
name
stringRequired
parent__id
string
sync_state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete file

Description

Deletes a file, either permanently or by moving it to the trash. the the enterprise settings determine whether the item will be permanently deleted from box or moved to the trash.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download file

Description

Returns the contents of a file in binary format.

Action Parameters

access_token
string
file_id
stringRequired
version
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get file information

Description

Retrieves the details about a file.

Action Parameters

fields
array
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get folder information

Description

Retrieves details for a folder, including the first 100 entries in the folder. passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](r://folder--full#param-item-collection). to fetch more items within the folder, use the [get items in a folder](e://get-folders-id-items) endpoint.

Action Parameters

direction
string
fields
array
folder_id
stringRequired
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List file comments

Description

Retrieves a list of comments for a file.

Action Parameters

fields
array
file_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List items in folder

Description

Retrieves a page of items in a folder. these items can be files, folders, and web links. to request more information about the folder itself, like its size, use the [get a folder](#get-folders-id) endpoint instead.

Action Parameters

direction
string
fields
array
folder_id
stringRequired
limit
integer
marker
string
offset
integer
sort
string
usemarker
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Request access token

Description

Request an access token using either a client-side obtained oauth 2.0 authorization code or a server-side jwt assertion. an access token is a string that enables box to verify that a request belongs to an authorized session. in the normal order of operations you will begin by requesting authentication from the [authorize](#get-authorize) endpoint and box will send you an authorization code. you will then send this code to this endpoint to exchange it for an access token. the returned access token can then be used to to make box api calls.

Action Parameters

actor_token
string
actor_token_type
string
assertion
string
box_shared_link
string
box_subject_id
string
box_subject_type
string
client_id
string
client_secret
string
code
string
grant_type
stringRequired
refresh_token
string
resource
string
scope
string
subject_token
string
subject_token_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search for content

Description

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Action Parameters

ancestor_folder_ids
array
content_types
array
created_at_range
array
deleted_at_range
array
deleted_user_ids
array
direction
stringDefaults to DESC
fields
array
file_extensions
array
include_recent_shared_links
boolean
limit
integerDefaults to 30
mdfilters
array
offset
integer
owner_user_ids
array
query
string
recent_updater_user_ids
array
scope
stringDefaults to user_content
size_range
array
sort
stringDefaults to relevance
trash_content
stringDefaults to non_trashed_only
type
string
updated_at_range
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update file

Description

Updates a file. this can be used to rename or move a file, create a shared link, or lock a file.

Action Parameters

collections
array
description
string
disposition_at
string
fields
array
file_id
stringRequired
lock__access
string
lock__expires__at
string
lock__is__download__prevented
boolean
name
string
permissions__can__download
string
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update folder

Description

Updates a folder. this can be also be used to move the folder, create shared links, update collaborations, and more.

Action Parameters

can_non_owners_invite
boolean
can_non_owners_view_collaborators
boolean
collections
array
description
string
fields
array
folder_id
stringRequired
is_collaboration_restricted_to_enterprise
boolean
name
string
sync_state
string
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add classification to file

Description

Adds a classification to a file by specifying the label of the classification to add. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

Box__Security__Classification__Key
string
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add classification to folder

Description

Adds a classification to a folder by specifying the label of the classification to add. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

Box__Security__Classification__Key
string
folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add domain to list of allowed collaboration domains

Description

Creates a new entry in the list of allowed domains to allow collaboration for.

Action Parameters

direction
stringRequired
domain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add initial classifications

Description

When an enterprise does not yet have any classifications, this api call initializes the classification template with an initial set of classifications. if an enterprise already has a classification, the template will already exist and instead an api call should be made to add additional classifications.

Action Parameters

copyInstanceOnItemCopy
boolean
displayName
stringRequired
fields
arrayRequired
hidden
boolean
scope
stringRequired
templateKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add or update user avatar

Description

Adds or updates a user avatar.

Action Parameters

pic
object
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add user to group

Description

Creates a group membership. only users with admin-level permissions will be able to use this api.

Action Parameters

configurable_permissions
object
fields
array
group__id
string
role
string
user__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Apply watermark to file

Description

Applies or update a watermark on a file.

Action Parameters

file_id
stringRequired
watermark__imprint
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Apply watermark to folder

Description

Applies or update a watermark on a folder.

Action Parameters

folder_id
stringRequired
watermark__imprint
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Ask question

Description

Sends an ai request to supported llms and returns an answer specifically focused on the user's question given the provided context.

Action Parameters

dialogue_history
array
include_citations
boolean
items
arrayRequired
mode
stringRequired
prompt
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign retention policy

Description

Assigns a retention policy to an item.

Action Parameters

assign__to__id
string
assign__to__type
string
filter_fields
array
policy_id
stringRequired
start_date_field
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign storage policy

Description

Creates a storage policy assignment for an enterprise or user.

Action Parameters

assigned__to__id
string
assigned__to__type
string
storage__policy__id
string
storage__policy__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign task

Description

Assigns a task to a user. a task can be assigned to more than one user by creating multiple assignments.

Action Parameters

assign__to__id
string
assign__to__login
string
task__id
string
task__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Authorize user

Description

Authorize a user by sending them through the [box](https://box.com) website and request their permission to act on their behalf. this is the first step when authenticating a user using oauth 2.0. to request a user's authorization to use the box apis on their behalf you will need to send a user to the url with this format.

Action Parameters

client_id
stringRequired
redirect_uri
string
response_type
stringRequired
scope
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel box sign request

Description

Cancels a sign request.

Action Parameters

sign_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Change shield information barrier status

Description

Change status of shield information barrier with the specified id.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Commit upload session

Description

Close an upload session and create a file from the uploaded chunks. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Action Parameters

parts
arrayRequired
upload_session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Copy file

Description

Creates a copy of a file.

Action Parameters

fields
array
file_id
stringRequired
name
string
parent__id
string
version
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Copy file request

Description

Copies an existing file request that is already present on one folder, and applies it to another folder.

Action Parameters

file_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Copy folder

Description

Creates a copy of a folder within a destination folder. the original folder will not be changed.

Action Parameters

fields
array
folder_id
stringRequired
name
string
parent__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create ai agent

Description

Creates an ai agent. at least one of the following capabilities must be provided: `ask`, `text gen`, `extract`.

Action Parameters

access_state
stringRequired
allowed_entities
array
ask__access__state
string
ask__custom__instructions
string
ask__description
string
ask__type
string
extract__access__state
string
extract__custom__instructions
string
extract__description
string
extract__type
string
icon_reference
string
name
stringRequired
text__gen__access__state
string
text__gen__custom__instructions
string
text__gen__description
string
text__gen__type
string
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create box skill cards on file

Description

Applies one or more box skills metadata cards to a file.

Action Parameters

cards
arrayRequired
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create user exemption from collaboration domain restrictions

Description

Create user exemption from collaboration domain restrictions.

Action Parameters

user__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create email alias

Description

Adds a new email alias to a user account..

Action Parameters

email
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create folder lock

Description

Creates a folder lock on a folder, preventing it from being moved and/or deleted. you must be authenticated as the owner or co-owner of the folder to use this endpoint.

Action Parameters

folder__id
string
folder__type
string
locked__operations__delete
boolean
locked__operations__move
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create group

Description

Creates a new group of users in an enterprise. only users with admin permissions can create new groups.

Action Parameters

description
string
external_sync_identifier
string
fields
array
invitability_level
string
member_viewability_level
string
name
stringRequired
provenance
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create jobs to terminate users session

Description

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. returns the status for the post request.

Action Parameters

user_ids
arrayRequired
user_logins
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create jobs to terminate user group session

Description

Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. returns the status for the post request.

Action Parameters

group_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create metadata cascade policy

Description

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. in order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

Action Parameters

folder_id
stringRequired
scope
stringRequired
templateKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create metadata instance on file

Description

Applies an instance of a metadata template to a file. in most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

Action Parameters

file_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create metadata instance on folder

Description

Applies an instance of a metadata template to a folder. in most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair. to display the metadata template in the box web app the enterprise needs to be configured to enable **cascading folder level metadata** for the user in the admin console.

Action Parameters

folder_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create metadata template

Description

Creates a new metadata template that can be applied to files and folders.

Action Parameters

copyInstanceOnItemCopy
boolean
displayName
stringRequired
fields
array
hidden
boolean
scope
stringRequired
templateKey
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create retention policy

Description

Creates a retention policy.

Action Parameters

are_owners_notified
boolean
can_owner_extend_retention
boolean
custom_notification_recipients
array
description
string
disposition_action
stringRequired
policy_name
stringRequired
policy_type
stringRequired
retention_length
string
retention_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create shield information barrier

Description

Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create shield information barrier report

Description

Creates a shield information barrier report for a given barrier.

Action Parameters

shield__information__barrier__id
string
shield__information__barrier__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create shield information barrier segment

Description

Creates a shield information barrier segment.

Action Parameters

description
string
name
stringRequired
shield__information__barrier__id
string
shield__information__barrier__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create shield information barrier segment member

Description

Creates a new shield information barrier segment member.

Action Parameters

shield__information__barrier__id
string
shield__information__barrier__segment__id
string
shield__information__barrier__segment__type
string
shield__information__barrier__type
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create shield information barrier segment restriction

Description

Creates a shield information barrier segment restriction object.

Action Parameters

restricted__segment__id
string
restricted__segment__type
string
shield__information__barrier__id
string
shield__information__barrier__segment__id
string
shield__information__barrier__segment__type
string
shield__information__barrier__type
string
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create slack integration mapping

Description

Creates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) by mapping a slack channel to a box item. you need admin or co-admin role to use this endpoint.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create task

Description

Creates a single task on a file. this task is not assigned to any user and will need to be assigned separately.

Action Parameters

action
stringDefaults to review
completion_rule
stringDefaults to all_assignees
due_at
string
item__id
string
item__type
string
message
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create teams integration mapping

Description

Creates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) by mapping a teams channel to a box item. you need admin or co-admin role to use this endpoint.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create terms of service

Description

Creates a terms of service for a given enterprise and type of user.

Action Parameters

status
stringRequired
text
stringRequired
tos_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create terms of service status for new user

Description

Sets the status for a terms of service for a user.

Action Parameters

is_accepted
booleanRequired
tos__id
string
tos__type
string
user__id
string
user__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create upload session

Description

Creates an upload session for a new file.

Action Parameters

file_name
stringRequired
file_size
integerRequired
folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create upload session for existing file

Description

Creates an upload session for an existing file.

Action Parameters

file_id
stringRequired
file_name
string
file_size
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create user

Description

Creates a new managed user in an enterprise. this endpoint is only available to users and applications with the right admin permissions.

Action Parameters

address
string
can_see_managed_users
boolean
external_app_user_id
string
fields
array
is_exempt_from_device_limits
boolean
is_exempt_from_login_verification
boolean
is_external_collab_restricted
boolean
is_platform_access_only
boolean
is_sync_enabled
boolean
job_title
string
language
string
login
string
name
stringRequired
phone
string
role
string
space_amount
integer
status
string
timezone
string
tracking_codes
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create user invite

Description

Invites an existing external user to join an enterprise. the existing user can not be part of another enterprise and must already have a box account. once invited, the user will receive an email and are prompted to accept the invitation within the box web application. this method requires the "manage an enterprise" scope enabled for the application, which can be enabled within the developer console.

Action Parameters

actionable__by__login
string
enterprise__id
string
fields
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create webhook

Description

Creates a webhook.

Action Parameters

address
stringRequired
target__id
string
target__type
string
triggers
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create zip download

Description

Creates a request to download multiple files and folders as a single `zip` archive file. this api does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download url` and a `status url` that can be used to download the archive. the limit for an archive is either the account's upload limit or 10,000 files, whichever is met first. **note**: downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. for these reasons we recommend that a maximum zip archive total size does not exceed 25gb.

Action Parameters

download_file_name
string
items
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete ai agent

Description

Deletes an ai agent using the provided parameters.

Action Parameters

agent_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete shield information barrier segment restriction by id

Description

Delete shield information barrier segment restriction by id.

Action Parameters

shield_information_barrier_segment_restriction_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete file request

Description

Deletes a file request permanently.

Action Parameters

file_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete folder

Description

Deletes a folder, either permanently or by moving it to the trash.

Action Parameters

folder_id
stringRequired
recursive
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete folder lock

Description

Deletes a folder lock on a given folder. you must be authenticated as the owner or co-owner of the folder to use this endpoint.

Action Parameters

folder_lock_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete retention policy

Description

Permanently deletes a retention policy.

Action Parameters

retention_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete shield information barrier segment

Description

Deletes the shield information barrier segment based on provided id.

Action Parameters

shield_information_barrier_segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete shield information barrier segment member by id

Description

Deletes a shield information barrier segment member based on provided id.

Action Parameters

shield_information_barrier_segment_member_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete slack integration mapping

Description

Deletes a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). you need admin or co-admin role to use this endpoint.

Action Parameters

integration_mapping_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete teams integration mapping

Description

Deletes a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). you need admin or co-admin role to use this endpoint.

Action Parameters

integration_mapping_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete user

Description

Deletes a user. by default this will fail if the user still owns any content. move their owned content first before proceeding, or use the `force` field to delete the user and their files.

Action Parameters

force
boolean
notify
boolean
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete user avatar

Description

Removes an existing user avatar. you cannot reverse this operation.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download zip archive

Description

Returns the contents of a `zip` archive in binary format. this url does not require any form of authentication and could be used in a user's browser to download the archive to a user's device. by default, this url is only valid for a few seconds from the creation of the request for this archive. once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created. the url of this endpoint should not be considered as fixed. instead, use the [create zip download](e://post zip downloads) api to request to create a `zip` archive, and then follow the `download url` field in the response to this endpoint.

Action Parameters

zip_download_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Extract metadata freeform

Description

Sends an ai request to supported large language models (llms) and extracts metadata in form of key-value pairs. in this request, both the prompt and the output can be freeform. metadata template setup before sending the request is not required.

Action Parameters

items
arrayRequired
prompt
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Extract metadata structured

Description

Sends an ai request to supported large language models (llms) and returns extracted metadata as a set of key-value pairs. for this request, you either need a metadata template or a list of fields you want to extract. input is **either** a metadata template or a list of fields to ensure the structure. to learn more about creating templates, see [creating metadata templates in the admin console](https://support.box.com/hc/en-us/articles/360044194033-customizing-metadata-templates) or use the [metadata template api](g://metadata/templates/create).

Action Parameters

fields
array
items
arrayRequired
metadata__template__scope
string
metadata__template__template__key
string
metadata__template__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Find metadata template by instance id

Description

Finds a metadata template by searching for the id of an instance of the template.

Action Parameters

limit
integer
marker
string
metadata_instance_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Force apply metadata cascade policy to folder

Description

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. this can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

Action Parameters

conflict_resolution
stringRequired
metadata_cascade_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate text

Description

Sends an ai request to supported large language models (llms) and returns generated text based on the provided prompt.

Action Parameters

dialogue_history
array
items
arrayRequired
prompt
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get ai agent by agent id

Description

Gets an ai agent using the `agent id` parameter.

Action Parameters

agent_id
stringRequired
fields
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get ai agent default configuration

Description

Get the ai agent default config

Action Parameters

language
string
mode
stringRequired
model
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get allowed collaboration domain

Description

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

Action Parameters

collaboration_whitelist_entry_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get box sign request by id

Description

Gets a sign request by id.

Action Parameters

sign_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get box sign template by id

Description

Fetches details of a specific box sign template.

Action Parameters

template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get classification on file

Description

Retrieves the classification metadata instance that has been applied to a file. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get classification on folder

Description

Retrieves the classification metadata instance that has been applied to a folder. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get collaboration

Description

Retrieves a single collaboration.

Action Parameters

collaboration_id
stringRequired
fields
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get collection by id

Description

Retrieves a collection by its id.

Action Parameters

collection_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get comment

Description

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Action Parameters

comment_id
stringRequired
fields
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get current user

Description

Retrieves information about the user who is currently authenticated. in the case of a client-side authenticated oauth 2.0 application this will be the user who authorized the app. in the case of a jwt, server-side authenticated application this will be the service account that belongs to the application by default. use the `as-user` header to change who this api call is made on behalf of.

Action Parameters

fields
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get device pin

Description

Retrieves information about an individual device pin.

Action Parameters

device_pinner_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get events long poll endpoint

Description

The listevents endpoint provides information about the events available in the box system. this options method allows developers to discover the capabilities and requirements for interacting with the /events endpoint. it's particularly useful for understanding the types of events that can be monitored, the format of event data, and any constraints or limitations on event retrieval. this endpoint should be used when setting up event monitoring or webhook integrations to ensure proper configuration and understanding of the event system. while it doesn't directly fetch events, it offers crucial metadata for effectively working with box's event streaming and notification features.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get files under retention

Description

Returns a list of files under retention for a retention policy assignment.

Action Parameters

limit
integer
marker
string
retention_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get file request

Description

Retrieves the information about a file request.

Action Parameters

file_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get file thumbnail

Description

Retrieves a thumbnail, or smaller image representation, of a file. sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format. thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/migrating-and-previewing-content/file-types-and-fonts-supported-in-box-content-preview/ta-p/327

Action Parameters

extension
stringRequired
file_id
stringRequired
max_height
integer
max_width
integer
min_height
integer
min_width
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get file version

Description

Retrieve a specific version of a file. versions are only tracked for box users with premium accounts.

Action Parameters

fields
array
file_id
stringRequired
file_version_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get file versions under retention

Description

Returns a list of file versions under retention for a retention policy assignment.

Action Parameters

limit
integer
marker
string
retention_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get group

Description

Retrieves information about a group. only members of this group or users with admin-level permissions will be able to use this api.

Action Parameters

fields
array
group_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get group membership

Description

Retrieves a specific group membership. only admins of this group or users with admin-level permissions will be able to use this api.

Action Parameters

fields
array
group_membership_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metadata cascade policy

Description

Retrieve a specific metadata cascade policy assigned to a folder.

Action Parameters

metadata_cascade_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metadata instance on file

Description

Retrieves the instance of a metadata template that has been applied to a file.

Action Parameters

file_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metadata instance on folder

Description

Retrieves the instance of a metadata template that has been applied to a folder. this can not be used on the root folder with id `0`.

Action Parameters

folder_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metadata template by id

Description

Retrieves a metadata template by its id.

Action Parameters

template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metadata template by name

Description

Retrieves a metadata template by its `scope` and `templatekey` values. to find the `scope` and `templatekey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Action Parameters

scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get retention on file

Description

Returns information about a file version retention. **note**: file retention api is now **deprecated**. to get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Action Parameters

file_version_retention_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get retention policy

Description

Retrieves a retention policy.

Action Parameters

fields
array
retention_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get retention policy assignment

Description

Retrieves a retention policy assignment

Action Parameters

fields
array
retention_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get shield information barrier report by id

Description

Retrieves a shield information barrier report by its id.

Action Parameters

shield_information_barrier_report_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get shield information barrier segment member by id

Description

Retrieves a shield information barrier segment member by its id.

Action Parameters

shield_information_barrier_segment_member_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get shield information barrier segment restriction by id

Description

Retrieves a shield information barrier segment restriction based on provided id.

Action Parameters

shield_information_barrier_segment_restriction_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get shield information barrier segment with specified id

Description

Retrieves shield information barrier segment based on provided id..

Action Parameters

shield_information_barrier_segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get shield information barrier with specified id

Description

Get shield information barrier based on provided id.

Action Parameters

shield_information_barrier_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get storage policy

Description

Fetches a specific storage policy.

Action Parameters

storage_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get storage policy assignment

Description

Fetches a specific storage policy assignment.

Action Parameters

storage_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get task

Description

Retrieves information about a specific task.

Action Parameters

task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get task assignment

Description

Retrieves information about a task assignment.

Action Parameters

task_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get terms of service

Description

Fetches a specific terms of service.

Action Parameters

terms_of_service_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get trashed file

Description

Retrieves a file that has been moved to the trash. please note that only if the file itself has been moved to the trash can it be retrieved with this api call. if instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`get /folders/:id/trash`](e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.

Action Parameters

fields
array
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get trashed folder

Description

Retrieves a folder that has been moved to the trash. please note that only if the folder itself has been moved to the trash can it be retrieved with this api call. if instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`get /folders/:id/trash`](e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.

Action Parameters

fields
array
folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get upload session

Description

Return information about an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) endpoint.

Action Parameters

upload_session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user

Description

Retrieves information about a user in the enterprise. the application and the authenticated user need to have the permission to look up users in the entire enterprise. this endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. in this case, disallowed fields will return null instead.

Action Parameters

fields
array
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user avatar

Description

Retrieves an image of a the user's avatar.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user exempt from collaboration domain restrictions

Description

Returns a users who has been exempt from the collaboration domain restrictions.

Action Parameters

collaboration_whitelist_exempt_target_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user invite status

Description

Returns the status of a user invite.

Action Parameters

fields
array
invite_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get watermark for folder

Description

Retrieve the watermark for a folder.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get watermark on file

Description

Retrieve the watermark for a file.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get webhook

Description

Retrieves a specific webhook

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get zip download status

Description

Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. this endpoint can only be accessed once the download has started. subsequently this endpoint is valid for 12 hours from the start of the download. the url of this endpoint should not be considered as fixed. instead, use the [create zip download](e://post zip downloads) api to request to create a `zip` archive, and then follow the `status url` field in the response to this endpoint.

Action Parameters

zip_download_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List ai agents

Description

Lists ai agents based on the provided parameters.

Action Parameters

agent_state
array
fields
array
include_box_default
boolean
limit
integer
marker
string
mode
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List allowed collaboration domains

Description

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all classifications

Description

Retrieves the classification metadata template and lists all the classifications available to this enterprise. this api can also be called by including the enterprise id in the url explicitly, for example `/metadata templates/enterprise 12345/securityclassification-6vmvochwuwo/schema`.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all collections

Description

Retrieves all collections for a given user. currently, only the `favorites` collection is supported.

Action Parameters

fields
array
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all file versions

Description

Retrieve a list of the past versions for a file. versions are only tracked by box users with premium accounts. to fetch the id of the current version of a file, use the `get /file/:id` api.

Action Parameters

fields
array
file_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all global metadata templates

Description

Used to retrieve all generic, global metadata templates available to all enterprises using box.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all metadata templates for enterprise

Description

Used to retrieve all metadata templates created to be used specifically within the user's enterprise

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all webhooks

Description

Returns all defined webhooks for the requesting application. this api only returns webhooks that are applied to files or folders that are owned by the authenticated user. this means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List box sign requests

Description

Gets signature requests created by a user. if the `sign files` and/or `parent folder` are deleted, the signature request will not return in the list.

Action Parameters

limit
integer
marker
string
senders
array
shared_requests
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List box sign templates

Description

Gets box sign templates created by a user.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List box skill cards on file

Description

List the box skills metadata cards that are attached to a file.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List collection items

Description

Retrieves the files and/or folders contained within this collection.

Action Parameters

collection_id
stringRequired
fields
array
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List enterprise device pins

Description

Retrieves all the device pins within an enterprise. the user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

Action Parameters

direction
string
enterprise_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List enterprise users

Description

Returns a list of all users for the enterprise along with their `user id`, `public name`, and `login`. the application and the authenticated user need to have the permission to look up users in the entire enterprise.

Action Parameters

external_app_user_id
string
fields
array
filter_term
string
limit
integer
marker
string
offset
integer
usemarker
boolean
user_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List file app item associations

Description

**this is a beta feature, which means that its availability might be limited.** returns all app items the file is associated with. this includes app items associated with ancestors of the file. assuming the context user has access to the file, the type/ids are revealed even if the context user does not have **view** permission on the app item.

Action Parameters

application_type
string
file_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List file collaborations

Description

Retrieves a list of pending and active collaborations for a file. this returns all the users that have access to the file or have been invited to the file.

Action Parameters

fields
array
file_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List file version retentions

Description

Retrieves all file version retentions for the given enterprise. **note**: file retention api is now **deprecated**. to get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Action Parameters

disposition_action
string
disposition_after
string
disposition_before
string
file_id
string
file_version_id
string
limit
integer
marker
string
policy_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List folder app item associations

Description

**this is a beta feature, which means that its availability might be limited.** returns all app items the folder is associated with. this includes app items associated with ancestors of the folder. assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have **view** permission on the app item.

Action Parameters

application_type
string
folder_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List folder collaborations

Description

Retrieves a list of pending and active collaborations for a folder. this returns all the users that have access to the folder or have been invited to the folder.

Action Parameters

fields
array
folder_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List folder locks

Description

Retrieves folder lock details for a given folder. you must be authenticated as the owner or co-owner of the folder to use this endpoint.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List groups for enterprise

Description

Retrieves all of the groups for a given enterprise. the user must have admin permissions to inspect enterprise's groups.

Action Parameters

fields
array
filter_term
string
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List group collaborations

Description

Retrieves all the collaborations for a group. the user must have admin permissions to inspect enterprise's groups. each collaboration object has details on which files or folders the group has access to and with what role.

Action Parameters

group_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List previous file versions for legal hold policy assignment

Description

List previous file versions for legal hold policy assignment

Action Parameters

fields
array
legal_hold_policy_assignment_id
stringRequired
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List members of group

Description

Retrieves all the members for a group. only members of this group or users with admin-level permissions will be able to use this api.

Action Parameters

group_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List metadata cascade policies

Description

Retrieves a list of all the metadata cascade policies that are applied to a given folder. this can not be used on the root folder with id `0`.

Action Parameters

folder_id
stringRequired
marker
string
offset
integer
owner_enterprise_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List metadata instances on file

Description

Retrieves all metadata for a given file.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List metadata instances on folder

Description

Retrieves all metadata for a given folder. this can not be used on the root folder with id `0`.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List parts

Description

Return a list of the chunks uploaded to the upload session so far. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Action Parameters

limit
integer
offset
integer
upload_session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List pending collaborations

Description

Retrieves all pending collaboration invites for this user.

Action Parameters

fields
array
limit
integer
offset
integer
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List recently accessed items

Description

Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Action Parameters

fields
array
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List retention policies

Description

Retrieves all of the retention policies for an enterprise.

Action Parameters

created_by_user_id
string
fields
array
limit
integer
marker
string
policy_name
string
policy_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List retention policy assignments

Description

Returns a list of all retention policy assignments associated with a specified retention policy.

Action Parameters

fields
array
limit
integer
marker
string
retention_policy_id
stringRequired
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List shield information barriers

Description

Retrieves a list of shield information barrier objects for the enterprise of jwt.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List shield information barrier reports

Description

Lists shield information barrier reports.

Action Parameters

limit
integer
marker
string
shield_information_barrier_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List shield information barrier segments

Description

Retrieves a list of shield information barrier segment objects for the specified information barrier id.

Action Parameters

limit
integer
marker
string
shield_information_barrier_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List shield information barrier segment members

Description

Lists shield information barrier segment members based on provided segment ids.

Action Parameters

limit
integer
marker
string
shield_information_barrier_segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List shield information barrier segment restrictions

Description

Lists shield information barrier segment restrictions based on provided segment id.

Action Parameters

limit
integer
marker
string
shield_information_barrier_segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List slack integration mappings

Description

Lists [slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) in a users' enterprise. you need admin or co-admin role to use this endpoint.

Action Parameters

box_item_id
string
box_item_type
string
is_manually_created
boolean
limit
integer
marker
string
partner_item_id
string
partner_item_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List storage policies

Description

Fetches all the storage policies in the enterprise.

Action Parameters

fields
array
limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List storage policy assignments

Description

Fetches all the storage policy assignment for an enterprise or user.

Action Parameters

marker
string
resolved_for_id
stringRequired
resolved_for_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List tasks on file

Description

Retrieves a list of all the tasks for a file. this endpoint does not support pagination.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List task assignments

Description

Lists all of the assignments for a given task.

Action Parameters

task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List teams integration mappings

Description

Lists [teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) in a users' enterprise. you need admin or co-admin role to use this endpoint.

Action Parameters

box_item_id
string
box_item_type
string
partner_item_id
string
partner_item_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List terms of services

Description

Returns the current terms of service text and settings for the enterprise.

Action Parameters

tos_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List terms of service user statuses

Description

Retrieves an overview of users and their status for a terms of service, including whether they have accepted the terms and when.

Action Parameters

tos_id
stringRequired
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List trashed items

Description

Retrieves the files and folders that have been moved to the trash. any attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default. this endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the `marker` parameter.

Action Parameters

direction
string
fields
array
limit
integer
marker
string
offset
integer
sort
string
usemarker
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List users exempt from collaboration domain restrictions

Description

Returns a list of users who have been exempt from the collaboration domain restrictions.

Action Parameters

limit
integer
marker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List user and enterprise events

Description

Returns up to a year of past events for a given user or for the entire enterprise. by default this returns events for the authenticated user. to retrieve events for the entire enterprise, set the `stream type` to `admin logs streaming` for live monitoring of new events, or `admin logs` for querying across historical events. the user making the api call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.

Action Parameters

created_after
string
created_before
string
event_type
array
limit
integerDefaults to 100
stream_position
string
stream_type
stringDefaults to all

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List user s email aliases

Description

Retrieves all email aliases for a user. the collection does not include the primary login for the user.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List user s groups

Description

Retrieves all the groups for a user. only members of this group or users with admin-level permissions will be able to use this api.

Action Parameters

limit
integer
offset
integer
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List workflows

Description

Returns list of workflows that act on a given `folder id`, and have a flow with a trigger type of `workflow manual start`. you application must be authorized to use the `manage box relay` application scope within the developer console in to use this endpoint.

Action Parameters

folder_id
stringRequired
limit
integer
marker
string
trigger_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Permanently remove file

Description

Permanently deletes a file that is in the trash. this action cannot be undone.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Permanently remove folder

Description

Permanently deletes a folder that is in the trash. this action cannot be undone.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Preflight check before upload

Description

Performs a check to verify that a file will be accepted by box before you upload the entire file.

Action Parameters

name
string
size
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Promote file version

Description

Promote a specific version of a file. if previous versions exist, this method can be used to promote one of the older versions to the top of the version history. this creates a new copy of the old version and puts it at the top of the versions history. the file will have the exact same contents as the older version, with the the same hash digest, `etag`, and name as the original. other properties such as comments do not get updated to their former values. don't use this endpoint to restore box notes, as it works with file formats such as pdf, doc, pptx or similar.

Action Parameters

fields
array
file_id
stringRequired
id
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query files folders by metadata

Description

Create a search using sql-like syntax to return items that match specific metadata. by default, this endpoint returns only the most basic info about the items for which the query matches. to get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.

Action Parameters

ancestor_folder_id
stringRequired
fields
array
from
stringRequired
limit
integerDefaults to 100
marker
string
order_by
array
query
string
query_params
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Refresh access token

Description

Refresh an access token using its client id, secret, and refresh token.

Action Parameters

client_id
stringRequired
client_secret
stringRequired
grant_type
stringRequired
refresh_token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove box skill cards from file

Description

Removes any box skills cards metadata from a file.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove classification from file

Description

Removes any classifications from a file. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove classification from folder

Description

Removes any classifications from a folder. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove collaboration

Description

Deletes a single collaboration.

Action Parameters

collaboration_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove comment

Description

Permanently deletes a comment.

Action Parameters

comment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove device pin

Description

Deletes an individual device pin.

Action Parameters

device_pinner_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove domain from list of allowed collaboration domains

Description

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

Action Parameters

collaboration_whitelist_entry_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove email alias

Description

Removes an email alias from a user.

Action Parameters

email_alias_id
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove file version

Description

Move a file version to the trash. versions are only tracked for box users with premium accounts.

Action Parameters

file_id
stringRequired
file_version_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove group

Description

Permanently deletes a group. only users with admin-level permissions will be able to use this api.

Action Parameters

group_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove metadata cascade policy

Description

Deletes a metadata cascade policy.

Action Parameters

metadata_cascade_policy_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove metadata instance from file

Description

Deletes a piece of file metadata.

Action Parameters

file_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove metadata instance from folder

Description

Deletes a piece of folder metadata.

Action Parameters

folder_id
stringRequired
scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove metadata template

Description

Delete a metadata template and its instances. this deletion is permanent and can not be reversed.

Action Parameters

scope
stringRequired
template_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove retention policy assignment

Description

Removes a retention policy assignment applied to content.

Action Parameters

retention_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove task

Description

Removes a task from a file.

Action Parameters

task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove upload session

Description

Abort an upload session and discard all data uploaded. this cannot be reversed. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Action Parameters

upload_session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove User Domain Exemption

Description

Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.

Action Parameters

collaboration_whitelist_exempt_target_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove user from group

Description

Deletes a specific group membership. only admins of this group or users with admin-level permissions will be able to use this api.

Action Parameters

group_membership_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove watermark from file

Description

Removes the watermark from a file.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove watermark from folder

Description

Removes the watermark from a folder.

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove webhook

Description

Deletes a webhook.

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Resend box sign request

Description

Resends a signature request email to all outstanding signers.

Action Parameters

sign_request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Restore file

Description

Restores a file that has been moved to the trash. an optional new parent id can be provided to restore the file to in case the original folder has been deleted.

Action Parameters

fields
array
file_id
stringRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Restore file version

Description

Restores a specific version of a file after it was deleted. don't use this endpoint to restore box notes, as it works with file formats such as pdf, doc, pptx or similar.

Action Parameters

file_id
stringRequired
file_version_id
stringRequired
trashed_at
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Restore folder

Description

Restores a folder that has been moved to the trash. an optional new parent id can be provided to restore the folder to in case the original folder has been deleted. during this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. for the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Action Parameters

fields
array
folder_id
stringRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Revoke access token

Description

Revoke an active access token, effectively logging a user out that has been previously authenticated.

Action Parameters

client_id
string
client_secret
string
token
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Starts workflow based on request body

Description

Initiates a flow with a trigger type of `workflow manual start`. you application must be authorized to use the `manage box relay` application scope within the developer console.

Action Parameters

files
arrayRequired
flow__id
string
flow__type
string
folder__id
string
folder__type
string
outcomes
array
type
string
workflow_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Transfer owned folders

Description

Transfers ownership of a specific folder (with id 0) from one user to another in the box cloud storage system. this endpoint should be used when you need to change the owner of a user's root folder, effectively transferring all of their content to another user. it's particularly useful in scenarios such as employee offboarding or role transitions within an organization. the operation is irreversible, so it should be used with caution. note that this endpoint specifically targets the folder with id 0, which typically represents a user's root folder in box.

Action Parameters

fields
array
notify
boolean
owned__by__id
string
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unassign storage policy

Description

Delete a storage policy assignment. deleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy. there is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame.

Action Parameters

storage_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unassign task

Description

Deletes a specific task assignment.

Action Parameters

task_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update ai agent

Description

Updates an ai agent.

Action Parameters

access_state
stringRequired
agent_id
stringRequired
allowed_entities
array
ask__access__state
string
ask__custom__instructions
string
ask__description
string
ask__type
string
extract__access__state
string
extract__custom__instructions
string
extract__description
string
extract__type
string
icon_reference
string
name
stringRequired
text__gen__access__state
string
text__gen__custom__instructions
string
text__gen__description
string
text__gen__type
string
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update all box skill cards on file

Description

An alternative method that can be used to overwrite and update all box skill metadata cards on a file.

Action Parameters

file__id
string
file__type
string
file__version__id
string
file__version__type
string
metadata__cards
array
skill_id
stringRequired
status
stringRequired
usage__unit
string
usage__value
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update shield information barrier segment with specified id

Description

Update shield information barrier segment with specified id

Action Parameters

description
string
name
string
shield_information_barrier_segment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update collaboration

Description

Updates a collaboration. can be used to change the owner of an item, or to accept collaboration invites.

Action Parameters

can_view_path
boolean
collaboration_id
stringRequired
expires_at
string
role
stringRequired
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update comment

Description

Update the message of a comment.

Action Parameters

comment_id
stringRequired
fields
array
message
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update file request

Description

Updates a file request. this can be used to activate or deactivate a file request.

Action Parameters

description
string
expires_at
string
file_request_id
stringRequired
is_description_required
boolean
is_email_required
boolean
status
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update group

Description

Updates a specific group. only admins of this group or users with admin-level permissions will be able to use this api.

Action Parameters

description
string
external_sync_identifier
string
fields
array
group_id
stringRequired
invitability_level
string
member_viewability_level
string
name
string
provenance
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update group membership

Description

Updates a user's group membership. only admins of this group or users with admin-level permissions will be able to use this api.

Action Parameters

configurable_permissions
object
fields
array
group_membership_id
stringRequired
role
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update retention policy

Description

Updates a retention policy.

Action Parameters

are_owners_notified
boolean
can_owner_extend_retention
boolean
custom_notification_recipients
array
description
string
disposition_action
string
policy_name
string
retention_length
string
retention_policy_id
stringRequired
retention_type
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update slack integration mapping

Description

Updates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.

Action Parameters

integration_mapping_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update storage policy assignment

Description

Updates a specific storage policy assignment.

Action Parameters

storage__policy__id
string
storage__policy__type
string
storage_policy_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task

Description

Updates a task. this can be used to update a task's configuration, or to update its completion state.

Action Parameters

action
string
completion_rule
string
due_at
string
message
string
task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task assignment

Description

Updates a task assignment. this endpoint can be used to update the state of a task assigned to a user.

Action Parameters

message
string
resolution_state
string
task_assignment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update teams integration mapping

Description

Updates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.

Action Parameters

integration_mapping_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update terms of service

Description

Updates a specific terms of service.

Action Parameters

status
stringRequired
terms_of_service_id
stringRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update terms of service status for existing user

Description

Updates the status for a terms of service for a user.

Action Parameters

is_accepted
booleanRequired
terms_of_service_user_status_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update user

Description

Updates a managed or app user in an enterprise. this endpoint is only available to users and applications with the right admin permissions.

Action Parameters

address
string
can_see_managed_users
boolean
enterprise
string
external_app_user_id
string
fields
array
is_exempt_from_device_limits
boolean
is_exempt_from_login_verification
boolean
is_external_collab_restricted
boolean
is_password_reset_required
boolean
is_sync_enabled
boolean
job_title
string
language
string
login
string
name
string
notification__email__email
string
notify
boolean
phone
string
role
string
space_amount
integer
status
string
timezone
string
tracking_codes
array
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update webhook

Description

Updates a webhook.

Action Parameters

address
string
target__id
string
target__type
string
triggers
array
webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload file

Description

Uploads a small file to box. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.

Action Parameters

attributes
object
fields
array
file
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload file version

Description

Update a file's content. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.

Action Parameters

attributes
object
fields
array
file
object
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload part of file

Description

Uploads a chunk of a file for an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Action Parameters

file
object
upload_session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired