Box

使用说明

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.

工具

`box_upload_file`

Upload a file to a Box folder

输入

参数	类型	必填	描述
`parentFolderId`	string	是	The ID of the folder to upload the file to (use "0" for root)
`file`	file	否	The file to upload (UserFile object)
`fileContent`	string	否	Legacy: base64 encoded file content
`fileName`	string	否	Optional filename override

输出

参数	类型	描述
`id`	string	File ID
`name`	string	File name
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_download_file`

Download a file from Box

输入

参数	类型	必填	描述
`fileId`	string	是	The ID of the file to download

输出

参数	类型	描述
`file`	file	Downloaded file stored in execution files
`content`	string	Base64 encoded file content

`box_get_file_info`

Get detailed information about a file in Box

输入

参数	类型	必填	描述
`fileId`	string	是	The ID of the file to get information about

输出

参数	类型	描述
`id`	string	File ID
`name`	string	File name
`description`	string	File description
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`createdBy`	object	User who created the file
`modifiedBy`	object	User who last modified the file
`ownedBy`	object	User who owns the file
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name
`sharedLink`	json	Shared link details
`tags`	array	File tags
`commentCount`	number	Number of comments

`box_list_folder_items`

List files and folders in a Box folder

输入

参数	类型	必填	描述
`folderId`	string	是	The ID of the folder to list items from (use "0" for root)
`limit`	number	否	Maximum number of items to return per page
`offset`	number	否	The offset for pagination
`sort`	string	否	Sort field: id, name, date, or size
`direction`	string	否	Sort direction: ASC or DESC

输出

参数	类型	描述
`entries`	array	List of items in the folder
↳ `type`	string	Item type (file, folder, web_link)
↳ `id`	string	Item ID
↳ `name`	string	Item name
↳ `size`	number	Item size in bytes
↳ `createdAt`	string	Creation timestamp
↳ `modifiedAt`	string	Last modified timestamp
`totalCount`	number	Total number of items in the folder
`offset`	number	Current pagination offset
`limit`	number	Current pagination limit

`box_create_folder`

Create a new folder in Box

输入

参数	类型	必填	描述
`name`	string	是	Name for the new folder
`parentFolderId`	string	是	The ID of the parent folder (use "0" for root)

输出

参数	类型	描述
`id`	string	Folder ID
`name`	string	Folder name
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_delete_file`

Delete a file from Box

输入

参数	类型	必填	描述
`fileId`	string	是	The ID of the file to delete

输出

参数	类型	描述
`deleted`	boolean	Whether the file was successfully deleted
`message`	string	Success confirmation message

`box_delete_folder`

Delete a folder from Box

输入

参数	类型	必填	描述
`folderId`	string	是	The ID of the folder to delete
`recursive`	boolean	否	Delete folder and all its contents recursively

输出

参数	类型	描述
`deleted`	boolean	Whether the folder was successfully deleted
`message`	string	Success confirmation message

`box_copy_file`

Copy a file to another folder in Box

输入

参数	类型	必填	描述
`fileId`	string	是	The ID of the file to copy
`parentFolderId`	string	是	The ID of the destination folder
`name`	string	否	Optional new name for the copied file

输出

参数	类型	描述
`id`	string	File ID
`name`	string	File name
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_search`

Search for files and folders in Box

输入

参数	类型	必填	描述
`query`	string	是	The search query string
`limit`	number	否	Maximum number of results to return
`offset`	number	否	The offset for pagination
`ancestorFolderId`	string	否	Restrict search to a specific folder and its subfolders
`fileExtensions`	string	否	Comma-separated file extensions to filter by (e.g., pdf,docx)
`type`	string	否	Restrict to a specific content type: file, folder, or web_link

输出

参数	类型	描述
`results`	array	Search results
↳ `type`	string	Item type (file, folder, web_link)
↳ `id`	string	Item ID
↳ `name`	string	Item name
↳ `size`	number	Item size in bytes
↳ `createdAt`	string	Creation timestamp
↳ `modifiedAt`	string	Last modified timestamp
↳ `parentId`	string	Parent folder ID
↳ `parentName`	string	Parent folder name
`totalCount`	number	Total number of matching results

`box_update_file`

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

输入

参数	类型	必填	描述
`fileId`	string	是	The ID of the file to update
`name`	string	否	New name for the file
`description`	string	否	New description for the file (max 256 characters)
`parentFolderId`	string	否	Move the file to a different folder by specifying the folder ID
`tags`	string	否	Comma-separated tags to set on the file

输出

参数	类型	描述
`id`	string	File ID
`name`	string	File name
`description`	string	File description
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`createdBy`	object	User who created the file
`modifiedBy`	object	User who last modified the file
`ownedBy`	object	User who owns the file
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name
`sharedLink`	json	Shared link details
`tags`	array	File tags
`commentCount`	number	Number of comments

`box_sign_create_request`

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

输入

参数	类型	必填	描述
`sourceFileIds`	string	是	Comma-separated Box file IDs to send for signing
`signerEmail`	string	是	Primary signer email address
`signerRole`	string	否	Primary signer role: signer, approver, or final_copy_reader (default: signer)
`additionalSigners`	string	否	JSON array of additional signers, e.g. [{"email":"user@example.com","role":"signer"}]
`parentFolderId`	string	否	Box folder ID where signed documents will be stored (default: user root)
`emailSubject`	string	否	Custom subject line for the signing email
`emailMessage`	string	否	Custom message in the signing email body
`name`	string	否	Name for the sign request
`daysValid`	number	否	Number of days before the request expires (0-730)
`areRemindersEnabled`	boolean	否	Whether to send automatic signing reminders
`areTextSignaturesEnabled`	boolean	否	Whether to allow typed (text) signatures
`signatureColor`	string	否	Signature color: blue, black, or red
`redirectUrl`	string	否	URL to redirect signers to after signing
`declinedRedirectUrl`	string	否	URL to redirect signers to after declining
`isDocumentPreparationNeeded`	boolean	否	Whether document preparation is needed before sending
`externalId`	string	否	External system reference ID

输出

参数	类型	描述
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_get_request`

Get the details and status of a Box Sign request

输入

参数	类型	必填	描述
`signRequestId`	string	是	The ID of the sign request to retrieve

输出

参数	类型	描述
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_list_requests`

List all Box Sign requests

输入

参数	类型	必填	描述
`limit`	number	否	Maximum number of sign requests to return (max 1000)
`marker`	string	否	Pagination marker from a previous response

输出

参数	类型	描述
`signRequests`	array	List of sign requests
↳ `id`	string	Sign request ID
↳ `status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
↳ `name`	string	Sign request name
↳ `shortId`	string	Human-readable short ID
↳ `signers`	array	List of signers
↳ `sourceFiles`	array	Source files for signing
↳ `emailSubject`	string	Custom email subject line
↳ `emailMessage`	string	Custom email message body
↳ `daysValid`	number	Number of days the request is valid
↳ `createdAt`	string	Creation timestamp
↳ `autoExpireAt`	string	Auto-expiration timestamp
↳ `prepareUrl`	string	URL for document preparation (if preparation is needed)
↳ `senderEmail`	string	Email of the sender
`count`	number	Number of sign requests returned in this page
`nextMarker`	string	Marker for next page of results

`box_sign_cancel_request`

Cancel a pending Box Sign request

输入

参数	类型	必填	描述
`signRequestId`	string	是	The ID of the sign request to cancel

输出

参数	类型	描述
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_resend_request`

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

输入

参数	类型	必填	描述
`signRequestId`	string	是	The ID of the sign request to resend

输出

参数	类型	描述
`message`	string	Success confirmation message

On this page