Procedures

Automation procedures in the Dropbox book.

The following documentation is for Dropbox v1.0.4 (BDK).

Make sure to add the Dropbox book to your agent before using these automation procedures.

to create a folder at a path

Creates a folder at the specified path in Dropbox.

Input Concepts

Concept	Description	Type	Required	Default Value
path	The absolute path for the new folder (e.g., "/New Folder Name").	text	Yes	(no default)
autorename	If true, Dropbox will automatically rename the folder if a conflict occurs. Defaults to False.	boolean	No	False

Output Concepts

Concept	Description	Type
answer	The FolderMetadata of the newly created folder.	dropbox folder metadata

Examples

create a folder at "/"

create a folder at "/my/new/folder/path/"

to delete an item and get the item reference

Deletes a file or folder in Dropbox using its metadata and returns the metadata of the deleted item.

Input Concepts

Concept	Description	Type	Required	Default Value
item	The FileMetadata or FolderMetadata object representing the item to delete.	dropbox file metadata or dropbox folder metadata	Yes	(no default)

Output Concepts

Concept	Description	Type
item reference	Metadata (FileMetadata, FolderMetadata, or DeletedMetadata) of the deleted item.	dropbox deleted metadata or dropbox file metadata or dropbox folder metadata

Examples

...
use the above as the file reference
delete the file reference and get the item reference

...
use the above as the folder reference
delete the folder reference and get the item reference

to download a file

Downloads a file from Dropbox using its metadata.

Input Concepts

Concept	Description	Type	Required	Default Value
file	The FileMetadata object representing the file to download.	dropbox file metadata	Yes	(no default)

Output Concepts

Concept	Description	Type
answer	An IO[bytes] object containing the file content.	file

Examples

...
use the above as the file reference
download the file reference

to upload a file and get the file reference

Uploads a file to a specific path in Dropbox and returns its metadata.

Max file size 150MB. For larger files, use upload sessions.

Input Concepts

Concept	Description	Type	Required	Default Value
file	The file content as a byte stream (IO).	file	Yes	(no default)
file name	The name the file should have in Dropbox (e.g., "Matrices.txt").	text	Yes	(no default)
dropbox path	The destination folder path in Dropbox where the file will be uploaded (e.g., "/Homework/math" or "/Homework/math/").	text	Yes	(no default)
mode	Selects what to do if a file already exists. Can be "add", "overwrite", or "update".	text	No	add
autorename	If there's a conflict, autorename the file.	boolean	No	True
mute	Whether to mute notifications for this change.	boolean	No	False
client modified timestamp	The client's last modification timestamp (ISO 8601 UTC).	text	No	(no default)
strict conflict	If true, behaves like 'overwrite' but property groups are not updated.	boolean	No	False

Output Concepts

Concept	Description	Type
file reference	A FileMetadata object representing the uploaded file.	dropbox file metadata

Examples

...
use the above as the file
upload the file and get the file reference