273 things your agent can do in Box

Download file

Returns the contents of a file in binary format.

Find app item for shared link

Returns the app item represented by a shared link. the link can originate from the current enterprise or another.

Find file for shared link

Returns the file represented by a shared link. a shared file can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an applicat…

Find folder for shared link

Return the folder represented by a shared link. a shared folder can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an appli…

Find metadata template by instance id

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

Find web link for shared link

Returns the web link represented by a shared link. a shared web link can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an…

Get ai agent by agent id

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

Get ai agent default configuration

Get the ai agent default config

Get allowed collaboration domain

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

Get box sign request by id

Gets a sign request by id.

Get box sign template by id

Fetches details of a specific box sign template.

Get classification on file

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 1…

Get classification on folder

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/enterpris…

Get collaboration

Retrieves a single collaboration.

Get collection by id

Retrieves a collection by its id.

Get current user

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 jw…

Get device pin

Retrieves information about an individual device pin.

Get events long poll endpoint

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…

Get files under retention

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

Get file information

Retrieves the details about a file.

Get file request

Retrieves the information about a file request.

Get file thumbnail

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 `320x32…

Get file version

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

Get file versions under retention

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

Get file version legal hold

Retrieves information about the legal hold policies assigned to a file version.

Get folder information

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…

Get group

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

Get group membership

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

Get legal hold policy

Retrieve a legal hold policy.

Get legal hold policy assignment

Retrieve a legal hold policy assignment.

Get metadata cascade policy

Retrieve a specific metadata cascade policy assigned to a folder.

Get metadata instance on file

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

Get metadata instance on folder

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`.

Get metadata template by id

Retrieves a metadata template by its id.

Get metadata template by name

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 ap…

Get retention on file

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

Retrieves a retention policy.

Get retention policy assignment

Retrieves a retention policy assignment

Get shared link for file

Gets the information for a shared link on a file.

Get shared link for folder

Gets the information for a shared link on a folder.

Get shared link for web link

Gets the information for a shared link on a web link.

Get shield information barrier report by id

Retrieves a shield information barrier report by its id.

Get shield information barrier segment member by id

Retrieves a shield information barrier segment member by its id.

Get shield information barrier segment restriction by id

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

Get shield information barrier segment with specified id

Retrieves shield information barrier segment based on provided id..

Get shield information barrier with specified id

Get shield information barrier based on provided id.

Get storage policy

Fetches a specific storage policy.

Get storage policy assignment

Fetches a specific storage policy assignment.

Get task

Retrieves information about a specific task.

Get task assignment

Retrieves information about a task assignment.

Get terms of service

Fetches a specific terms of service.

Get trashed file

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 wa…

Get trashed folder

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 folder…

Get trashed web link

Retrieves a web link that has been moved to the trash.

Get user

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 li…

Get user avatar

Retrieves an image of a the user's avatar.

Get user exempt from collaboration domain restrictions

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

Get watermark for folder

Retrieve the watermark for a folder.

Get watermark on file

Retrieve the watermark for a file.

Get webhook

Retrieves a specific webhook

Get web link

Retrieve information about a web link.

Get zip download status

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…

List ai agents

Lists ai agents based on the provided parameters.

List allowed collaboration domains

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

List all classifications

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 ex…

List all collections

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

List all file versions

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.

List all global metadata templates

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

List all legal hold policies

Retrieves a list of legal hold policies that belong to an enterprise.

List all metadata templates for enterprise

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

List all webhooks

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…

List box sign requests

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.

List box sign templates

Gets box sign templates created by a user.

List box skill cards on file

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

List collection items

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

List enterprise device pins

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.

List enterprise users

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 e…

List file app item associations

**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. assum…

List file collaborations

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.

List file comments

Retrieves a list of comments for a file.

List file version legal holds

Get a list of file versions on legal hold for a legal hold assignment. due to ongoing re-architecture efforts this api might not return all file versions for this policy id. instead, this api will on…

List file version retentions

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…

List folder app item associations

**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. a…

List folder collaborations

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.

List folder locks

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.

List groups for enterprise

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

List group collaborations

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…

List items in folder

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) en…

List legal hold policy assignments

Retrieves a list of items a legal hold policy has been assigned to.

List members of group

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.

List metadata cascade policies

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`.

List metadata instances on file

Retrieves all metadata for a given file.

List metadata instances on folder

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

List parts

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://…

List pending collaborations

Retrieves all pending collaboration invites for this user.

List previous file versions for legal hold policy assignment

List previous file versions for legal hold policy assignment

List recently accessed items

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

List retention policies

Retrieves all of the retention policies for an enterprise.

List retention policy assignments

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

List shield information barriers

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

List shield information barrier reports

Lists shield information barrier reports.

List shield information barrier segments

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

List shield information barrier segment members

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

List shield information barrier segment restrictions

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

List slack integration mappings

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 endp…

List storage policies

Fetches all the storage policies in the enterprise.

List storage policy assignments

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

List tasks on file

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

List task assignments

Lists all of the assignments for a given task.

List teams integration mappings

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.

List terms of services

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

List terms of service user statuses

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

List trashed items

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 attribute…

List users exempt from collaboration domain restrictions

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

List user and enterprise events

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 `st…

List user s groups

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.

List workflows

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…

Query files folders by metadata

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 addi…

Search for content

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

Add classification to file

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//enterp…

Add classification to folder

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/ent…

Add domain to list of allowed collaboration domains

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

Add initial classifications

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,…

Add or update user avatar

Adds or updates a user avatar.

Add shared link to file

Adds a shared link to a file.

Add shared link to folder

Adds a shared link to a folder.

Add shared link to web link

Adds a shared link to a web link.

Add user to group

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

Commit upload session

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:/…

Create ai agent

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

Create box sign request

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

Create box skill cards on file

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

Create collaboration

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 g…

Create folder

Creates a new empty folder within the specified parent folder.

Create folder lock

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.

Create group

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

Create jobs to terminate users session

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.

Create jobs to terminate user group session

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.

Create legal hold policy

Create a new legal hold policy.

Create metadata cascade policy

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 applie…

Create metadata instance on file

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 a…

Create metadata instance on folder

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…

Create metadata template

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

Create retention policy

Creates a retention policy.

Create shield information barrier

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

Create shield information barrier report

Creates a shield information barrier report for a given barrier.

Create shield information barrier segment

Creates a shield information barrier segment.

Create shield information barrier segment member

Creates a new shield information barrier segment member.

Create shield information barrier segment restriction

Creates a shield information barrier segment restriction object.

Create slack integration mapping

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…

Create task

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

Create teams integration mapping

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…

Create terms of service

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

Create terms of service status for new user

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

Create upload session

Creates an upload session for a new file.

Create upload session for existing file

Creates an upload session for an existing file.

Create user

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

Create user exemption from collaboration domain restrictions

Create user exemption from collaboration domain restrictions.

Create webhook

Creates a webhook.

Create web link

Creates a web link object within a folder.

Create zip download

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…

Delete ai agent

Deletes an ai agent using the provided parameters.

Delete file

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.

Delete file request

Deletes a file request permanently.

Delete folder

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

Delete folder lock

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.

Delete retention policy

Permanently deletes a retention policy.

Delete shield information barrier segment

Deletes the shield information barrier segment based on provided id.

Delete shield information barrier segment member by id

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

Delete shield information barrier segment restriction by id

Delete shield information barrier segment restriction by id.

Delete slack integration mapping

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.

Delete teams integration mapping

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.

Delete user

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.

Delete user avatar

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

Download zip archive

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 def…

Get upload session

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

Permanently remove file

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

Permanently remove folder

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

Permanently remove web link

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

Preflight check before upload

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

Remove box skill cards from file

Removes any box skills cards metadata from a file.

Remove classification from file

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…

Remove classification from folder

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-6vmvochw…

Remove collaboration

Deletes a single collaboration.

Remove device pin

Deletes an individual device pin.

Remove domain from list of allowed collaboration domains

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

Remove file version

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

Remove group

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

Remove legal hold policy

Delete an existing legal hold policy. this is an asynchronous process. the policy will not be fully deleted yet when the response returns.

Remove metadata cascade policy

Deletes a metadata cascade policy.

Remove metadata instance from file

Deletes a piece of file metadata.

Remove metadata instance from folder

Deletes a piece of folder metadata.

Remove metadata template

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

Remove retention policy assignment

Removes a retention policy assignment applied to content.

Remove shared link from file

Removes a shared link from a file.

Remove shared link from folder

Removes a shared link from a folder.

Remove shared link from web link

Removes a shared link from a web link.

Remove task

Removes a task from a file.

Remove upload session

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 s…

Remove User Domain Exemption

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

Remove user from group

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

Remove watermark from file

Removes the watermark from a file.

Remove watermark from folder

Removes the watermark from a folder.

Remove webhook

Deletes a webhook.

Remove web link

Deletes a web link.

Update ai agent

Updates an ai agent.

Update all box skill cards on file

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

Update collaboration

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

Update file

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

Update file request

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

Update folder

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

Update group

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

Update group membership

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

Update legal hold policy

Update legal hold policy.

Update retention policy

Updates a retention policy.

Update shared link on file

Updates a shared link on a file.

Update shared link on folder

Updates a shared link on a folder.

Update shared link on web link

Updates a shared link on a web link.

Update shield information barrier segment with specified id

Update shield information barrier segment with specified id

Update slack integration mapping

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 c…

Update storage policy assignment

Updates a specific storage policy assignment.

Update task

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

Update task assignment

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

Update teams integration mapping

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…

Update terms of service

Updates a specific terms of service.

Update terms of service status for existing user

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

Update user

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

Update webhook

Updates a webhook.

Update web link

Updates a web link object.

Upload file

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 thi…

Upload file version

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 fo…

Upload part of file

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-s…

Create comment

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

Create email alias

Adds a new email alias to a user account..

Create user invite

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…

Get comment

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

Get user invite status

Returns the status of a user invite.

List user s email aliases

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

Remove comment

Permanently deletes a comment.

Remove email alias

Removes an email alias from a user.

Update comment

Update the message of a comment.

Apply watermark to file

Applies or update a watermark on a file.

Apply watermark to folder

Applies or update a watermark on a folder.

Ask question

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

Assign legal hold policy

Assign a legal hold to a file, file version, folder, or user.

Assign retention policy

Assigns a retention policy to an item.

Assign storage policy

Creates a storage policy assignment for an enterprise or user.

Assign task

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

Authorize user

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…

Cancel box sign request

Cancels a sign request.

Change shield information barrier status

Change status of shield information barrier with the specified id.

Copy file

Creates a copy of a file.

Copy file request

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

Copy folder

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

Extract metadata freeform

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 setu…

Extract metadata structured

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…

Force apply metadata cascade policy to folder

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…

Generate text

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

Promote file version

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 ve…

Refresh access token

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

Request access token

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…

Resend box sign request

Resends a signature request email to all outstanding signers.

Restore file

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.

Restore file version

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.

Restore folder

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…

Restore web link

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

Review files on legal hold policy assignment

Get a list of files with current file versions for a legal hold assignment. in some cases you may want to get previous file versions instead. in these cases, use the `get /legal hold policy assignmen…

Revoke access token

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

Starts workflow based on request body

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.

Transfer owned folders

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,…

Unassign legal hold policy

Remove a legal hold from an item. this is an asynchronous process. the policy will not be fully removed yet when the response returns.

Unassign storage policy

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…

Unassign task

Deletes a specific task assignment.