Box
Browse, search, read and organize the Box content a connected account collaborates on.
Connect a Box account to work with its content: list a folder, search by name or by what a document says, read the text Box extracted from a PDF or Word file, write a new file in from the workspace, create folders, move and rename, delete to the trash, and put a shared link on an item. Acts as the signed-in account itself, so it reaches exactly the files and folders that account collaborates on. It does NOT download raw file bytes - Box serves those through a redirect this sandbox will not follow; read a document's text instead, or share it and fetch the link.
Connect
Sign in with Box. Sign in with Box to browse, search, read and organize the files you can reach in Box. An organization admin configures the OAuth app once under Integrations → OAuth apps; after that, connecting is a consent screen.
-
Connecting signs in as YOU - every tool reaches exactly the files and folders your Box account is a collaborator on, and a file it writes or deletes is written or deleted by you.
-
What this connection can do is capped by the Box app your admin registered, not by this screen: Box sets an app's permissions in the Box Developer Console. To give an agent read-only access, register the app read-only - sign-in cannot narrow it further.
-
Changing the app's permissions in Box does NOT change an existing connection. Reconnect after any change, or tools keep acting with the permissions the token was issued under.
-
Box refresh tokens expire 60 days after they are issued. A connection nothing has used for two months has to be reconnected.
-
Delete moves an item to your Box trash, where you can restore it.
-
For scheduled or triggered automations, connect a dedicated Box service account and invite it as a collaborator on the folders it should reach: automations cannot run as a person, so they need a service connection.
Tools
| Tool | Access | What it does |
|---|---|---|
Get current user (yekar.box.get-current-user) | Read | Read the connected Box account: name, login, which enterprise it belongs to, and how much storage it has used. Use it to confirm WHICH account this connection acts as before writing anything - every tool here acts as that account, and a connection made with a personal Box account instead of the enterprise one looks identical until a folder 404s. |
List folder (yekar.box.list-folder-items) | Read | List what is directly inside a Box folder. Omit folderId for the root. total is Box's own count of everything in the folder, which is why it can be larger than the number of rows returned - page with nextOffset to see the rest. |
Search Box (yekar.box.search) | Read | Find files and folders the connected account can reach, by name, description or what a document says. total is Box's own count of every match, not the number of rows returned. Box indexes asynchronously, so a file uploaded seconds ago may not be findable yet - use List folder to confirm a fresh upload. |
Get file or folder (yekar.box.get-item) | Read | Read one item's details: its name, size, where it sits, and when and by whom it last changed. Requires you to say whether the id is a file or a folder - Box numbers the two independently, so id 12345 may be both. Use it to confirm an id is what you think it is before overwriting or deleting it. |
Read file text (yekar.box.extract-text) | Read | Read the text Box extracted from a document (PDF, Word, PowerPoint, and the other formats Box indexes) and return it inline. Box generates this rendition lazily, so a file uploaded moments ago answers 'pending' - that is a real state, not an error, and the tool says so rather than returning an empty string. A file Box cannot extract text from (an image, an archive, a video) answers 'none'. |
Upload file (yekar.box.upload-file) | Write | Write a new file into a Box folder, from this run's workspace or an https URL. Files over 50 MB are refused - Box needs its chunked upload session for those and this integration does not implement one. A name that is already taken in that folder FAILS rather than overwriting: this tool only ever creates a new file, it never replaces one. |
Create folder (yekar.box.create-folder) | Write | Create a folder inside another Box folder. Omit parentFolderId to create it at the root. A name that is already taken in that folder FAILS rather than being silently reused - a folder that already exists is a different folder from the one you meant to create. |
Move or rename (yekar.box.move-item) | Write | Move a file or folder into another Box folder, rename it, or both. Moving a folder moves everything inside it. A name that is already taken at the destination fails rather than overwriting. |
Delete file or folder (yekar.box.delete-item) | Write | Move a file or folder to the connected account's Box trash, where the owner can restore it. A non-empty folder needs recursive, and deleting it deletes everything inside. Returns no details of what was deleted - Box answers a delete with an empty response, so read the item first if you need a record of it. |
Create shared link (yekar.box.create-shared-link) | Write | Put a shared link on a Box file or folder and return its URL. Check effectiveAccess on the result before treating a link as public: a Box enterprise policy can downgrade an open link to company-only and answer successfully, so what you asked for and what Box applied are two different fields. Calling this again on the same item REPLACES the link's settings rather than minting a second link. |
Notes
- Sign in with Box to connect - every tool acts as YOUR account, and a file it writes or deletes is written or deleted by you.
- What this connection can do is capped by the Box app your admin registered in the Box Developer Console, not by anything here. Changing that app's permissions does not change an existing connection - reconnect after any change.
- Box ids are digits, and the root folder's id is "0". Files and folders are numbered independently, which is why every tool that takes an id also asks whether it is a file or a folder.
- This integration cannot download raw file bytes: Box serves content through a redirect the tool sandbox refuses to follow. Use Read file text for a document's contents, or Create shared link and fetch its
downloadUrlwith the Fetch integration - noting that sharing PUBLISHES the file. - Read file text can answer 'still generating' for a file that was just uploaded. That is Box working, not a failure - retry shortly.
- Upload only ever creates a NEW file; a name already taken in that folder fails rather than overwriting.
- Check
effectiveAccesson a shared link before telling anyone it is public - a Box enterprise policy can downgrade an open link to company-only and still answer successfully. - For a schedule or a trigger, bind this as a service connection owned by a dedicated Box account invited as a collaborator on the relevant folders - an automation cannot run as whoever happened to start it.
- Anyone who can upload to a shared folder can write text your agent will read. Gate write and share steps in any automation whose reads come from a folder outsiders can add to.