{"openapi":"3.1.0","info":{"title":"Box (BYOK) API","version":"0.1.0","description":"Box (BYOK) lets an AI assistant read your own Box data through the Box API with a key you supply (developer token or OAuth access token (developer tokens expire quickly)). Read-only: 9 tools (get_current_user, list_folder_items, get_folder, search_content, get_file, list_folder_collaborations, list_file_versions, list_file_comments, list_recent_items). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-box.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-box/docs"},"termsOfService":"https://connectorbay.com/byok-box/terms"},"servers":[{"url":"https://byok-box.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-box/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Box user the token belongs to: id, name, login email, status, language, timezone and storage used and available","description":"Show the Box user the token belongs to: id, name, login email, status, language, timezone and storage used and available. Use for \"Which Box account is my token connected to and how much space have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folder_items":{"post":{"operationId":"list_folder_items","summary":"List the files, folders and web links directly inside a Box folder, with size and dates. Page with limit and offset. Use","description":"List the files, folders and web links directly inside a Box folder, with size and dates. Page with limit and offset. Use for \"What is in the root folder of my Box\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Box folder id as a string; the root folder is '0'.","maxLength":200,"title":"Folder Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many entries to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start position for paging, from 0 (up to 10000).","title":"Offset"},"sort":{"anyOf":[{"enum":["id","name","date","size"],"type":"string"},{"type":"null"}],"default":null,"description":"Secondary sort order: id, name, date or size (folders always come before files).","title":"Sort"},"direction":{"anyOf":[{"enum":["DESC","ASC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC.","title":"Direction"}},"required":["folder_id"],"title":"list_folder_itemsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_folder":{"post":{"operationId":"get_folder","summary":"Get one Box folder: name, description, size, owner, parent, status, sharing link and the number of items it holds. Use f","description":"Get one Box folder: name, description, size, owner, parent, status, sharing link and the number of items it holds. Use for \"Tell me about the Box folder with id 123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Box folder id as a string; the root folder is '0'.","maxLength":200,"title":"Folder Id","type":"string"}},"required":["folder_id"],"title":"get_folderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_content":{"post":{"operationId":"search_content","summary":"Search Box files, folders and web links by keywords (use quotes for a phrase; AND, OR, NOT in capitals). Can limit to a ","description":"Search Box files, folders and web links by keywords (use quotes for a phrase; AND, OR, NOT in capitals). Can limit to a type, extensions or folders. Use for \"Find Box files about the Q3 contract\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Search text. Quotes match an exact phrase; AND, OR and NOT must be upper case.","maxLength":300,"title":"Query","type":"string"},"type":{"anyOf":[{"enum":["file","folder","web_link"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this kind of item: file, folder or web_link.","title":"Type"},"file_extensions":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated file extensions without dots, for example 'pdf,docx'.","title":"File Extensions"},"ancestor_folder_ids":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated folder ids; only search inside these folders and their subfolders.","title":"Ancestor Folder Ids"},"content_types":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated parts to search: name, description, file_content, comments, tags.","title":"Content Types"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 200).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start position for paging, from 0 (up to 10000).","title":"Offset"}},"required":["query"],"title":"search_contentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_file":{"post":{"operationId":"get_file","summary":"Get one Box file's details: name, size, description, dates, owner, parent folder, hash, version number, comment count an","description":"Get one Box file's details: name, size, description, dates, owner, parent folder, hash, version number, comment count and sharing link. Use for \"Show details of the Box file with id 123456789\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_id":{"description":"Box file id as a string, the number in a Box file URL (for example '123456789').","maxLength":200,"title":"File Id","type":"string"}},"required":["file_id"],"title":"get_fileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folder_collaborations":{"post":{"operationId":"list_folder_collaborations","summary":"List who has access to a Box folder: each collaborator or group, their role, status and invite details. Use for \"Who has","description":"List who has access to a Box folder: each collaborator or group, their role, status and invite details. Use for \"Who has access to my Box folder 123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Box folder id as a string; the root folder is '0'.","maxLength":200,"title":"Folder Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many collaborations to return (1 to 1000).","title":"Limit"}},"required":["folder_id"],"title":"list_folder_collaborationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_file_versions":{"post":{"operationId":"list_file_versions","summary":"List the previous versions of a Box file with version number, size, who changed it and when (versions are tracked on som","description":"List the previous versions of a Box file with version number, size, who changed it and when (versions are tracked on some plans only). Use for \"Show the version history of Box file 123456789\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_id":{"description":"Box file id as a string, the number in a Box file URL (for example '123456789').","maxLength":200,"title":"File Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many entries to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start position for paging, from 0. Box rejects very large offsets (above 10000 on most lists).","title":"Offset"}},"required":["file_id"],"title":"list_file_versionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_file_comments":{"post":{"operationId":"list_file_comments","summary":"List the comments on a Box file with the message, author and time. Use for \"What comments are on Box file 123456789\".","description":"List the comments on a Box file with the message, author and time. Use for \"What comments are on Box file 123456789\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_id":{"description":"Box file id as a string, the number in a Box file URL (for example '123456789').","maxLength":200,"title":"File Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many entries to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start position for paging, from 0. Box rejects very large offsets (above 10000 on most lists).","title":"Offset"}},"required":["file_id"],"title":"list_file_commentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_recent_items":{"post":{"operationId":"list_recent_items","summary":"List the files and folders you opened, edited or uploaded recently (last 90 days or 1000 items) with the kind of interac","description":"List the files and folders you opened, edited or uploaded recently (last 90 days or 1000 items) with the kind of interaction and time. Use for \"What Box files did I work on recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 1000).","title":"Limit"}},"title":"list_recent_itemsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}