Dropbox

Description: Enable agents to interact with files and folders in Dropbox.

Author: Arcade

Code: GitHub

Auth: API Key

PyPI VersionLicensePython VersionsWheel StatusDownloads

The Arcade Dropbox toolkit provides a pre-built set of tools for interacting with Dropbox. These tools make it easy to build agents and AI apps that can:

  • Browse files and folders
  • Search for files and folders
  • Download files

Install

pip install arcade_dropbox

pip installing the toolkit is only needed if you are self-hosting Arcade. You do not need to install the toolkit if you’re using Arcade Cloud.

Available Tools

Tool NameDescription
ListItemsInFolderList all items in a folder.
SearchFilesAndFoldersSearch for files and folders in Dropbox.
DownloadFileDownload a file from Dropbox.

If you need to perform an action that’s not listed here, you can get in touch with us to request a new tool, or create your own tools.

ListItemsInFolder


List all items in a folder.

Parameters

  • folder_path (string, required) Path to the folder. E.g. ‘/My Documents/My Folder’
  • limit (int, optional, Defaults to 100) Maximum number of items to return. Defaults to 100. Maximum allowed is 2000.
  • cursor (string, optional) A cursor to use for pagination. Defaults to None.

SearchFilesAndFolders


Search for files and folders in Dropbox.

Parameters

  • keywords (string, required) The keywords to search for. E.g. ‘quarterly report’
  • search_in_folder_path (string, optional) Restricts the search to the specified folder path. E.g. ‘/My Documents/My Folder’. Defaults to None (search in the entire Dropbox).
  • filter_by_category (list of enum DropboxItemCategory, optional) Restricts the search to the specified category(ies) of items. Defaults to None (returns all items).
  • limit (int, optional, Defaults to 100) Maximum number of items to return. Defaults to 100. Maximum allowed is 2000.
  • cursor (string, optional) A cursor to use for pagination. Defaults to None.

DownloadFile


Download a file from Dropbox.

Parameters

  • file_path (string, optional) Path to the file. E.g. ‘/My Documents/My Folder/My File.pdf’
  • file_id (string, optional) The ID of the file to download. E.g. ‘id:a4ayc_80_OEAAAAAAAAAYa’

Note: to call this tool, you must provide either file_path or file_id.

Auth

The Arcade Dropbox toolkit uses the Dropbox auth provider to connect to users’ Dropbox accounts.

With the hosted Arcade Engine, there’s nothing to configure. Your users will see Arcade as the name of the application that’s requesting permission.

With a self-hosted installation of Arcade, you need to configure the Dropbox auth provider with your own Dropbox app credentials.