​

Storage API

​

Overview

• Direct Uploads: Upload files to specific paths.
• Integrated Uploads: Upload files when creating or updating documents.
• User Files: Support for user avatars and cover photos.
• S3-Backed: High-performance cloud storage for all file types.
• Public URLs: Automatically generated CDN-ready URLs.

​

File Upload

​

Endpoint

​

Parameters

​

Example

curl -X POST https://api.cocobase.cc/storage/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/image.jpg" \
  -F "path=products/"

const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('path', 'uploads/');

const res = await fetch('https://api.cocobase.cc/storage/upload', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer YOUR_KEY' },
  body: formData
});

​

Management Endpoints

​

List Files

• Endpoint: GET /storage/list
• Query Params: path, limit, offset

​

Delete File

• Endpoint: DELETE /storage/file/{id}

​

Storage Info

• Endpoint: GET /storage/info

​

Uploading with Users & Documents

​

User Profile Update with Avatar

curl -X PATCH https://api.cocobase.cc/auth-collections/user \
  -H "Authorization: Bearer <token>" \
  -F "avatar=@/path/to/avatar.jpg" \
  -F "data={\"bio\": \"Hello world\"}"

​

Document Creation with Files

curl -X POST https://api.cocobase.cc/collections/posts \
  -H "Authorization: Bearer <key>" \
  -F "image=@/path/to/post.jpg" \
  -F "data={\"title\": \"My Post\"}"

​

Best Practices

1. Validation: Always validate file types and sizes on the client side before uploading.
2. Organization: Use descriptive paths (e.g., /users/{id}/avatars/) to keep storage organized.
3. Optimizations: Compress images before upload to save space and improve load times.
4. Error Handling: Handle 413 (Payload Too Large) and storage limit errors gracefully.

​

Storage Limits

​

Supported Types

• Images: .jpg, .png, .webp, .gif, .svg
• Docs: .pdf, .docx, .txt, .csv
• Video: .mp4, .mov, .webm
• Archives: .zip, .tar.gz