Box

Manage files, folders, and e-signatures with Box

Box is a leading cloud content management and file sharing platform trusted by enterprises worldwide to securely store, manage, and collaborate on files. Box provides robust APIs for automating file operations and integrating with business workflows, including Box Sign for native e-signatures.

With the Box integration in Sim, you can:

  • Upload files: Upload documents, images, and other files to any Box folder
  • Download files: Retrieve file content from Box for processing in your workflows
  • Get file info: Access detailed metadata including size, owner, timestamps, tags, and shared links
  • List folder contents: Browse files and folders with sorting and pagination support
  • Create folders: Organize your Box storage by creating new folders programmatically
  • Delete files and folders: Remove content with optional recursive deletion for folders
  • Copy files: Duplicate files across folders with optional renaming
  • Search: Find files and folders by name, content, extension, or location
  • Update file metadata: Rename, move, add descriptions, or tag files
  • Create sign requests: Send documents for e-signature with one or more signers
  • Track signing status: Monitor the progress of sign requests
  • List sign requests: View all sign requests with marker-based pagination
  • Cancel sign requests: Cancel pending sign requests that are no longer needed
  • Resend sign reminders: Send reminder notifications to signers who haven't completed signing

These capabilities allow your Sim agents to automate Box operations directly within your workflows — from organizing documents and distributing content to processing uploaded files, managing e-signature workflows for offer letters and contracts, and maintaining structured cloud storage as part of your business processes.

Usage Instructions

Integrate Box into your workflow to manage files, folders, and e-signatures. Upload and download files, search content, create folders, send documents for e-signature, track signing status, and more.

Tools

box_upload_file

Upload a file to a Box folder

Input

ParameterTypeRequiredDescription
parentFolderIdstringYesThe ID of the folder to upload the file to (use "0" for root)
filefileNoThe file to upload (UserFile object)
fileContentstringNoLegacy: base64 encoded file content
fileNamestringNoOptional filename override

Output

ParameterTypeDescription
idstringFile ID
namestringFile name
sizenumberFile size in bytes
sha1stringSHA1 hash of file content
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
parentIdstringParent folder ID
parentNamestringParent folder name

box_download_file

Download a file from Box

Input

ParameterTypeRequiredDescription
fileIdstringYesThe ID of the file to download

Output

ParameterTypeDescription
filefileDownloaded file stored in execution files
contentstringBase64 encoded file content

box_get_file_info

Get detailed information about a file in Box

Input

ParameterTypeRequiredDescription
fileIdstringYesThe ID of the file to get information about

Output

ParameterTypeDescription
idstringFile ID
namestringFile name
descriptionstringFile description
sizenumberFile size in bytes
sha1stringSHA1 hash of file content
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
createdByobjectUser who created the file
modifiedByobjectUser who last modified the file
ownedByobjectUser who owns the file
parentIdstringParent folder ID
parentNamestringParent folder name
sharedLinkjsonShared link details
tagsarrayFile tags
commentCountnumberNumber of comments

box_list_folder_items

List files and folders in a Box folder

Input

ParameterTypeRequiredDescription
folderIdstringYesThe ID of the folder to list items from (use "0" for root)
limitnumberNoMaximum number of items to return per page
offsetnumberNoThe offset for pagination
sortstringNoSort field: id, name, date, or size
directionstringNoSort direction: ASC or DESC

Output

ParameterTypeDescription
entriesarrayList of items in the folder
typestringItem type (file, folder, web_link)
idstringItem ID
namestringItem name
sizenumberItem size in bytes
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
totalCountnumberTotal number of items in the folder
offsetnumberCurrent pagination offset
limitnumberCurrent pagination limit

box_create_folder

Create a new folder in Box

Input

ParameterTypeRequiredDescription
namestringYesName for the new folder
parentFolderIdstringYesThe ID of the parent folder (use "0" for root)

Output

ParameterTypeDescription
idstringFolder ID
namestringFolder name
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
parentIdstringParent folder ID
parentNamestringParent folder name

box_delete_file

Delete a file from Box

Input

ParameterTypeRequiredDescription
fileIdstringYesThe ID of the file to delete

Output

ParameterTypeDescription
deletedbooleanWhether the file was successfully deleted
messagestringSuccess confirmation message

box_delete_folder

Delete a folder from Box

Input

ParameterTypeRequiredDescription
folderIdstringYesThe ID of the folder to delete
recursivebooleanNoDelete folder and all its contents recursively

Output

ParameterTypeDescription
deletedbooleanWhether the folder was successfully deleted
messagestringSuccess confirmation message

box_copy_file

Copy a file to another folder in Box

Input

ParameterTypeRequiredDescription
fileIdstringYesThe ID of the file to copy
parentFolderIdstringYesThe ID of the destination folder
namestringNoOptional new name for the copied file

Output

ParameterTypeDescription
idstringFile ID
namestringFile name
sizenumberFile size in bytes
sha1stringSHA1 hash of file content
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
parentIdstringParent folder ID
parentNamestringParent folder name

Search for files and folders in Box

Input

ParameterTypeRequiredDescription
querystringYesThe search query string
limitnumberNoMaximum number of results to return
offsetnumberNoThe offset for pagination
ancestorFolderIdstringNoRestrict search to a specific folder and its subfolders
fileExtensionsstringNoComma-separated file extensions to filter by (e.g., pdf,docx)
typestringNoRestrict to a specific content type: file, folder, or web_link

Output

ParameterTypeDescription
resultsarraySearch results
typestringItem type (file, folder, web_link)
idstringItem ID
namestringItem name
sizenumberItem size in bytes
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
parentIdstringParent folder ID
parentNamestringParent folder name
totalCountnumberTotal number of matching results

box_update_file

Update file info in Box (rename, move, change description, add tags)

Input

ParameterTypeRequiredDescription
fileIdstringYesThe ID of the file to update
namestringNoNew name for the file
descriptionstringNoNew description for the file (max 256 characters)
parentFolderIdstringNoMove the file to a different folder by specifying the folder ID
tagsstringNoComma-separated tags to set on the file

Output

ParameterTypeDescription
idstringFile ID
namestringFile name
descriptionstringFile description
sizenumberFile size in bytes
sha1stringSHA1 hash of file content
createdAtstringCreation timestamp
modifiedAtstringLast modified timestamp
createdByobjectUser who created the file
modifiedByobjectUser who last modified the file
ownedByobjectUser who owns the file
parentIdstringParent folder ID
parentNamestringParent folder name
sharedLinkjsonShared link details
tagsarrayFile tags
commentCountnumberNumber of comments

box_sign_create_request

Create a new Box Sign request to send documents for e-signature

Input

ParameterTypeRequiredDescription
sourceFileIdsstringYesComma-separated Box file IDs to send for signing
signerEmailstringYesPrimary signer email address
signerRolestringNoPrimary signer role: signer, approver, or final_copy_reader (default: signer)
additionalSignersstringNoJSON array of additional signers, e.g. [{"email":"user@example.com","role":"signer"}]
parentFolderIdstringNoBox folder ID where signed documents will be stored (default: user root)
emailSubjectstringNoCustom subject line for the signing email
emailMessagestringNoCustom message in the signing email body
namestringNoName for the sign request
daysValidnumberNoNumber of days before the request expires (0-730)
areRemindersEnabledbooleanNoWhether to send automatic signing reminders
areTextSignaturesEnabledbooleanNoWhether to allow typed (text) signatures
signatureColorstringNoSignature color: blue, black, or red
redirectUrlstringNoURL to redirect signers to after signing
declinedRedirectUrlstringNoURL to redirect signers to after declining
isDocumentPreparationNeededbooleanNoWhether document preparation is needed before sending
externalIdstringNoExternal system reference ID

Output

ParameterTypeDescription
idstringSign request ID
statusstringRequest status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
namestringSign request name
shortIdstringHuman-readable short ID
signersarrayList of signers
sourceFilesarraySource files for signing
emailSubjectstringCustom email subject line
emailMessagestringCustom email message body
daysValidnumberNumber of days the request is valid
createdAtstringCreation timestamp
autoExpireAtstringAuto-expiration timestamp
prepareUrlstringURL for document preparation (if preparation is needed)
senderEmailstringEmail of the sender

box_sign_get_request

Get the details and status of a Box Sign request

Input

ParameterTypeRequiredDescription
signRequestIdstringYesThe ID of the sign request to retrieve

Output

ParameterTypeDescription
idstringSign request ID
statusstringRequest status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
namestringSign request name
shortIdstringHuman-readable short ID
signersarrayList of signers
sourceFilesarraySource files for signing
emailSubjectstringCustom email subject line
emailMessagestringCustom email message body
daysValidnumberNumber of days the request is valid
createdAtstringCreation timestamp
autoExpireAtstringAuto-expiration timestamp
prepareUrlstringURL for document preparation (if preparation is needed)
senderEmailstringEmail of the sender

box_sign_list_requests

List all Box Sign requests

Input

ParameterTypeRequiredDescription
limitnumberNoMaximum number of sign requests to return (max 1000)
markerstringNoPagination marker from a previous response

Output

ParameterTypeDescription
signRequestsarrayList of sign requests
idstringSign request ID
statusstringRequest status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
namestringSign request name
shortIdstringHuman-readable short ID
signersarrayList of signers
sourceFilesarraySource files for signing
emailSubjectstringCustom email subject line
emailMessagestringCustom email message body
daysValidnumberNumber of days the request is valid
createdAtstringCreation timestamp
autoExpireAtstringAuto-expiration timestamp
prepareUrlstringURL for document preparation (if preparation is needed)
senderEmailstringEmail of the sender
countnumberNumber of sign requests returned in this page
nextMarkerstringMarker for next page of results

box_sign_cancel_request

Cancel a pending Box Sign request

Input

ParameterTypeRequiredDescription
signRequestIdstringYesThe ID of the sign request to cancel

Output

ParameterTypeDescription
idstringSign request ID
statusstringRequest status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
namestringSign request name
shortIdstringHuman-readable short ID
signersarrayList of signers
sourceFilesarraySource files for signing
emailSubjectstringCustom email subject line
emailMessagestringCustom email message body
daysValidnumberNumber of days the request is valid
createdAtstringCreation timestamp
autoExpireAtstringAuto-expiration timestamp
prepareUrlstringURL for document preparation (if preparation is needed)
senderEmailstringEmail of the sender

box_sign_resend_request

Resend a Box Sign request to signers who have not yet signed

Input

ParameterTypeRequiredDescription
signRequestIdstringYesThe ID of the sign request to resend

Output

ParameterTypeDescription
messagestringSuccess confirmation message

On this page

Start building today
Trusted by over 100,000 builders.
The open-source platform to build AI agents and run your agentic workforce.
Get started