Buzstorage Quick Start
Start building with Buzstorage in minutes. We’ll walk you through account onboarding, API key management, and your first media integration.
1. Identity & Profile
Start by creating your account. Once registered, you must complete your Company Settings. This profile information is required to unlock full API capabilities and ensure secure billing routes.
2. Apps & Environments
Navigate to the Apps section to create a new application instance. Every app is provisioned with a Production environment by default. You can manually add Staging and Development environments to separate your testing and live traffic.
3. API Key Management
Each environment has its own set of Access Keys. These keys allow you to authenticate your requests and interact with our media pipeline across Development, Staging, and Production.
4. Infrastructure Hierarchy
Buzstorage follows a logical folder architecture with full support for nested directories. You can target deep locations using logical paths, allowing for precise organization of media assets. If a specified path does not exist, our system creates the entire hierarchy automatically, ensuring your uploads are always correctly contextualized without pre-configuring folders.
Logical Path Resolution
folderPath parameter (e.g., campaign/2026/branding). Storage accounting propagates instantly from the child file up to the master root directory.You must choose whether a folder is Public or Private. Private folders enforce strict security; files within them are permanently private and can only be accessed via trusted, authenticated requests. For public folders, you may granularly set individual files to private during upload via the isPublic=false flag.
5. Integration
Authenticate via the Authorization header using the pattern Bearer <ID>:<SECRET>.Note: You must include the full key strings including their prefixes (e.g., ak_prod_... and sk_prod_...). Buzstorage identifies your environment (Production, Staging, or Development) automatically based on these unique keys.
Automatic Environment Identification
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=campaign/2026/branding" \
-F "isPublic=false"Response Example
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"objectKey": "campaign/2026/branding/image.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"
}6. Content Retrieval
Fetch your uploaded assets securely. Buzstorage provides two distinct paths for file retrieval depending on your security and delivery needs.
6.1Base Retrieval (UUID)
The standard method to fetch any file (Private or Public). It requires the file's exact UUID and your Vault credentials in the Authorization header. This completely hides your backend folder hierarchy and prevents path enumeration.
curl -X GET "https://api.buzstorage.com/v1/files/<id>/content" \
-H "Authorization: Bearer <ACCESS_KEY_ID>:<SECRET_ACCESS_KEY>"6.2Public Edge Network
For files marked as isPublic: true, you can bypass authentication and serve them directly via our global edge network using the application name and logical folder path. Perfect for website assets.
<img src="https://api.buzstorage.com/api/v2/transform/<appName>/campaign/2026/branding/image.jpg" alt="Brand Image" />7. Just-in-Time Transformations
Buzstorage supports on-the-fly media transformations. When retrieving a public asset, append query parameters to instantly resize, compress, or adjust the image format at the edge before it reaches your user.
| Parameter | Description | Example |
|---|---|---|
| w | Width in pixels | ?w=800 |
| h | Height in pixels | ?h=600 |
| q | Quality (1-100) | ?q=80 |
| f | Format (webp, jpeg, png, avif) | ?f=webp |
<img src="https://api.buzstorage.com/api/v2/transform/<appName>/assets/hero.jpg?w=1200&q=85&f=webp" alt="Optimized Hero Image" />