API Endpoints
Detailed documentation of our external-facing endpoints for application integrations.
Files API
POST
/v1/files/upload
Upload a new file. Requires a multipart/form-data payload.
| Parameter | Type | Description |
|---|---|---|
| file | File | Required. The binary file content to upload. |
| folderPath | string | Optional. The logical folder path (e.g., assets/images). Created if it doesn't exist. |
| isPublic | boolean | Optional. Set to true to make the file accessible publicly. Default is false. |
curl -X POST https://api.buzstorage.com/v1/files/upload \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>" \
-F "file=@/path/to/image.jpg" \
-F "folderPath=assets/images"Response Example
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"objectKey": "image-123456.jpg",
"originalName": "image.jpg",
"mimeType": "image/jpeg",
"size": 102400,
"bucketType": "standard",
"isPublic": false,
"visibility": "private",
"scanStatus": "pending",
"processingStatus": "pending",
"uploadSource": "api",
"createdAt": "2026-06-17T12:00:00.000Z",
"updatedAt": "2026-06-17T12:00:00.000Z"
}GET
/v1/files
List files within an application or specific folder path.
| Query Param | Type | Description |
|---|---|---|
| applicationName | string | Optional. Filter files by application name. |
| folderPath | string | Optional. Filter files by exact folder path. |
curl -X GET "https://api.buzstorage.com/v1/files?folderPath=assets/images" \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>"Response Example
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"objectKey": "assets/images/image.jpg",
"originalName": "image.jpg",
"mimeType": "image/jpeg",
"size": 102400,
"isPublic": false,
"visibility": "private",
"scanStatus": "clean",
"processingStatus": "completed",
"createdAt": "2026-06-17T12:00:00.000Z"
}
],
"total": 1,
"page": 1,
"totalPages": 1
}GET
/v1/files/:id/content
Securely fetch or download a file using its unique UUID. This endpoint completely obscures your logical folder structure.
curl -X GET "https://api.buzstorage.com/v1/files/123e4567-e89b-12d3-a456-426614174000/content" \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>"GET
/api/v2/transform/:appName/*objectKey
Fetch a file using its logical folder path (objectKey) and apply on-the-fly transformations. Ideal for public CDN delivery and SEO-friendly URLs.
| Query Param | Type | Description |
|---|---|---|
| w | number | Optional. Target width for image resizing. |
| h | number | Optional. Target height for image resizing. |
| q | number | Optional. Quality percentage (1-100). Default is 80. |
curl -X GET "https://api.buzstorage.com/api/v2/transform/Buzmedia/campaign/2026/branding/image.jpg?w=800&q=80" \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>"Folders API
POST
/v1/folders
Create a new logical folder structure explicitly.
| Parameter | Type | Description |
|---|---|---|
| name | string | Required. The display name of the folder. |
| path | string | Optional. The logical path where the folder resides (e.g., assets/images). |
| makeFolderPrivate | boolean | Optional. Set to true to restrict access and make the files inside private. |
| applicationId | string | Optional. Associates this folder with a specific API Application. |
| isWatermarkEnabled | boolean | Optional. Set to true to automatically apply your company DRM watermark to all images served from this folder on-the-fly. |
{
"name": "assets",
"path": "assets/images",
"makeFolderPrivate": true,
"applicationId": "uuid-here",
"isWatermarkEnabled": true
}curl -X POST https://api.buzstorage.com/v1/folders \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>" \
-H "Content-Type: application/json" \
-d '{"name": "assets", "makeFolderPrivate": true, "isWatermarkEnabled": true}'Response Example
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "assets",
"companyId": "comp-1234",
"isSystemFolder": false,
"isPublic": false,
"encryptFolderContent": false,
"hasAdvancedDam": false,
"storageQuota": null,
"currentStorageUsed": 0,
"isWatermarkEnabled": true,
"isAutoCurationEnabled": false,
"createdAt": "2026-06-17T12:00:00.000Z",
"updatedAt": "2026-06-17T12:00:00.000Z"
}Search API
GET
/v1/search
Perform a global search across folders and files.
| Query Param | Type | Description |
|---|---|---|
| query | string | Required. The search term or keyword. |
curl -X GET "https://api.buzstorage.com/v1/search?query=logo" \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>"Response Example
{
"data": {
"apps": [],
"folders": [],
"files": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"objectKey": "assets/images/logo.png",
"originalName": "logo.png",
"mimeType": "image/png",
"size": 51200,
"isPublic": false,
"visibility": "private",
"createdAt": "2026-06-17T12:00:00.000Z"
}
]
}
}