API reference
Every /v1 operation, grouped by resource. Automate libraries, files, boards, pages, reviews and sharing in your brandspace.
Each group below lists its operations; every operation page shows parameters, request and response schemas, and examples. See Getting started for keys and Conventions for pagination, errors and versioning.
Meta
Who the key is, what it is allowed to do, and how much of its budget is left.
Libraries
Top-level containers. Called workspaces inside the product database.
Folders
Folders inside a library.
Imports
Import a file into the brandspace from a public URL.
Files
The central resource: metadata, renditions, moves, copies and deletion.
Downloads
Signed URLs for one file, and asynchronous ZIP downloads.
Uploads
Three-call presigned upload flow. Bytes go straight to S3.
Versions
Version history of a file.
Comments
Comments and replies on a file, with a CSV export.
Pages
Pages: structured documents, published or private.
Shared links
Public links to a file, folder, library or board.
Transfers
Send files and folders as a BTransfer, and manage the ones already sent.
Boards
Boards, the files on them, their properties and options.
Properties
Brandspace properties and options — the schema of the metadata layer.
Search
Keyword, semantic and natural-language search.
Brandspace
The brandspace behind the key, its members and its roles.
Webhooks
Webhook endpoints and their deliveries.