POST
/
v1
/
buckets
/
create
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/create \
  --header 'Content-Type: application/json' \
  --data '{
  "bucket_name": "user_profiles",
  "description": "Bucket for storing user profile information",
  "metadata": {
    "created_by": "admin",
    "department": "HR"
  },
  "schema": {
    "properties": {
      "user_picture": {
        "type": "image"
      },
      "documents": {
        "items": {
          "type": "object"
        },
        "type": "array"
      }
    }
  }
}'
{
  "bucket_id": "<string>",
  "bucket_name": "<string>",
  "description": "<string>",
  "bucket_schema": {
    "properties": {}
  },
  "metadata": {},
  "object_count": 123,
  "total_size_bytes": 123
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Body

application/json

Request model for creating a new bucket

​
bucket_name
string
required

Human-readable name for the bucket

​
bucket_schema
object
required

Schema definition for objects in this bucket, this cannot be updated after the bucket is created

​
description
string | null

Description of the bucket

​
metadata
object

Additional metadata for the bucket

Response

200
application/json
Successful Response

Response model for bucket operations

​
bucket_name
string
required

Human-readable name for the bucket

​
bucket_schema
object
required

Schema definition for objects in this bucket

​
object_count
integer
required

Number of objects in the bucket

​
total_size_bytes
integer
required

Total size of all objects in the bucket in bytes

​
bucket_id
string

Unique identifier for the bucket

​
description
string | null

Description of the bucket

​
metadata
object

Additional metadata for the bucket

Was this page helpful?

Suggest editsRaise issue