Buckets

​

Overview

• Purpose: Store registered objects (and their blobs) under a clear schema.
• Schema: Enforces allowed field names and types for blobs.
• Isolation: Use X-Namespace to scope buckets per tenant/environment.
• Processing: Bucket creation and object registration do not process data; collections handle processing later.

​

Bucket schema

{
  "bucket_name": "product-images",
  "description": "Product images and specs",
  "bucket_schema": {
    "properties": {
      "image_main": {"type": "image"},
      "specs": {"type": "json"}
    }
  }
}

• bucket_schema.properties: keys are blob field names; values specify the type.
• Objects referencing missing or mismatched fields are rejected.

​

Create a bucket

• API: Create Bucket
• Method: POST
• Path: /v1/buckets
• Reference: API Reference

curl -X POST https://api.mixpeek.com/v1/buckets \
  -H "Authorization: Bearer $API_KEY" \
  -H "X-Namespace: ns_123" \
  -H "Content-Type: application/json" \
  -d '{
    "bucket_name": "product-images",
    "description": "Product images and specs",
    "bucket_schema": {
      "properties": {
        "image_main": {"type": "image"},
        "specs": {"type": "json"}
      }
    }
  }'

​

Manage buckets

• Get Bucket
• Update Bucket
• Delete Bucket
• List Buckets

​

Behavior & validation

• Schema enforcement: Objects must conform to bucket_schema.
• Naming: bucket_name must be unique within a namespace.
• Schema mutability: Schema is set at creation; updates are limited to mutable fields (name, description, metadata).
• Rate limits: Bucket operations are rate-limited per account tier.

​

See also