Connect Box to vMira

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

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

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

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

Adds or updates a user avatar.

Adds a shared link to a file.

Adds a shared link to a folder.

Adds a shared link to a web link.

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

Applies or update a watermark on a file.

Applies or update a watermark on a folder.

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

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

Assigns a retention policy to an item.

Creates a storage policy assignment for an enterprise or user.

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

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

Cancels a sign request.

Change status of shield information barrier with the specified id.

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

Creates a copy of a file.

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

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

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

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

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

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

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

Adds a new email alias to a user account..

Creates a new empty folder within the specified parent folder.

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.

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

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.

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 a new legal hold 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 t...

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

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

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

Creates a retention policy.

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

Creates a shield information barrier report for a given barrier.

Creates a shield information barrier segment.

Creates a new shield information barrier segment member.

Creates a shield information barrier segment restriction object.

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

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

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

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

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

Creates an upload session for a new file.

Creates an upload session for an existing file.

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.

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

Creates a webhook.

Creates a web link object within a folder.

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

Deletes an ai agent using the provided parameters.

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.

Deletes a file request permanently.

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

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.

Permanently deletes a retention policy.

Deletes the shield information barrier segment based on provided id.

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

Delete shield information barrier segment restriction by id.

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

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.

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

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

Returns the contents of a file in binary format.

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

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

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

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

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

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

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

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

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

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

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

Get the ai agent default config

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

Gets a sign request by id.

Fetches details of a specific box sign template.

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

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

Retrieves a single collaboration.

Retrieves a collection by its id.

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

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

Retrieves information about an individual device pin.

The listevents endpoint provides information about the events available in the box system. this options method allows developers to discover the capabilities and requirements fo...

Retrieves the details about a file.

Retrieves the information about a file request.

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

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

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