Skip to main content
POST
/
v1
/
buckets
Create Bucket
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bucket_name": "<string>",
  "bucket_schema": {
    "properties": {}
  },
  "description": "<string>",
  "unique_key": {
    "default_policy": "upsert",
    "fields": [
      "video_id"
    ]
  },
  "metadata": {}
}
'
{
  "bucket_name": "<string>",
  "object_count": 123,
  "total_size_bytes": 123,
  "bucket_id": "<string>",
  "description": "<string>",
  "bucket_schema": {
    "properties": {}
  },
  "unique_key": {
    "default_policy": "upsert",
    "fields": [
      "video_id"
    ]
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_upload_at": "2023-11-07T05:31:56Z",
  "stats_updated_at": "2023-11-07T05:31:56Z",
  "status": "ACTIVE",
  "is_locked": false,
  "batch_stats": {
    "total": 0,
    "active": 0,
    "completed": 0,
    "failed": 0
  },
  "storage_stats": {
    "total_size_bytes": 0,
    "avg_size_bytes": 0,
    "max_size_bytes": 0,
    "min_size_bytes": 0
  },
  "source_adapter": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating a new bucket.

REQUIRED: A bucket_schema must be defined to enable data processing and validation.

The bucket_schema tells the system what fields your objects will have, enabling:

  • Collections to map your data fields to feature extractors via input_mappings
  • Validation of object structure at upload time
  • Type-safe data pipelines from bucket → collection → retrieval

Every bucket must have a schema that defines the structure of objects it will contain.

​
bucket_name
string
required

Human-readable name for the bucket

​
bucket_schema
BucketSchema · object
required

REQUIRED. Schema definition for objects in this bucket. Must include a 'properties' object mapping field names to type definitions. Use Mixpeek types (string, text, image, video, etc.) — NOT JSON Schema types like 'keyword'. Example: {"properties": {"title": {"type": "string"}, "photo": {"type": "image"}}}

​
description
string | null

Description of the bucket

​
unique_key
UniqueKeyConfig · object | null

Unique key configuration for this bucket (OPTIONAL). Enables uniqueness enforcement and upsert operations on specified field(s) from the schema. Cannot be changed after bucket creation.

Example:
{
  "default_policy": "upsert",
  "fields": ["video_id"]
}
​
metadata
Metadata · object

Additional metadata for the bucket

​
storage_class
enum<string> | null

OPTIONAL object-storage tier for this bucket's objects: standard | nearline | coldline | archive (provider-agnostic). NOTE: applied on write for sync-based ingestion (the primary media path); tiering for direct uploads (POST /objects) and presigned uploads, plus retroactive re-tiering of existing objects, are in progress (TG-2837). Omit for the provider default (standard).

Available options:
standard,
nearline,
coldline,
archive

Response

Successful Response

Response model for bucket operations.

​
bucket_name
string
required

Human-readable name for the 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

​
bucket_schema
BucketSchema · object | null

Schema definition for objects in this bucket

​
unique_key
UniqueKeyConfig · object | null

Unique key configuration for this bucket (if configured)

Example:
{
  "default_policy": "upsert",
  "fields": ["video_id"]
}
​
metadata
Metadata · object

Additional metadata for the bucket

​
storage_class
enum<string> | null

Object-storage tier for this bucket's objects: standard | nearline | coldline | archive. Provider-agnostic (GCS STANDARD/NEARLINE/COLDLINE/ARCHIVE; S3/MinIO STANDARD/STANDARD_IA/GLACIER). NOTE: applied on write for sync-based ingestion (the primary media path); tiering for direct/presigned uploads and retroactive re-tiering of existing objects are in progress (TG-2837). None = provider default.

Available options:
standard,
nearline,
coldline,
archive
​
created_at
string<date-time> | null

When the bucket was created

​
updated_at
string<date-time> | null

Last modification time of bucket metadata

​
last_upload_at
string<date-time> | null

When the last object was uploaded to this bucket

​
stats_updated_at
string<date-time> | null

When bucket stats were last successfully recalculated

​
status
enum<string>
default:ACTIVE

Bucket lifecycle status (ACTIVE, ARCHIVED, SUSPENDED, IN_PROGRESS for deleting)

Available options:
PENDING,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
INTERRUPTED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
​
is_locked
boolean
default:false

Whether the bucket is locked (read-only)

​
batch_stats
BatchStatistics · object | null

Batch statistics for this bucket (calculated asynchronously, stored in DB)

​
storage_stats
StorageStatistics · object | null

Storage statistics for this bucket (calculated asynchronously, stored in DB)

​
source_adapter
Source Adapter · object | null

Source adapter configuration for inbound webhook-driven ingestion