List Objects

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "search": "<string>",
  "select": [
    "metadata",
    "status",
    "created_at"
  ],
  "return_presigned_urls": false
}
'

{
  "results": [
    {
      "bucket_id": "<string>",
      "object_id": "<string>",
      "key_prefix": "<string>",
      "blobs": [
        {
          "property": "<string>",
          "blob_id": "<string>",
          "key_prefix": "/videos/video.mp4",
          "properties": {},
          "presigned_url": "<string>",
          "details": {
            "filename": "<string>",
            "size_bytes": 123,
            "mime_type": "<string>",
            "hash": "<string>"
          }
        }
      ],
      "source_details": [
        {
          "source_id": "<string>"
        }
      ],
      "status": "DRAFT",
      "error": "Failed to process object: Object not found",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "document_count": 123
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "stats": {
    "total_objects": 0,
    "total_blobs": 0,
    "avg_blobs_per_object": 0,
    "objects_by_status": {}
  }
}

Objects

List Objects

This endpoint lists objects in a bucket with cursor-based pagination, filtering, and sorting.

Filtering: Use dot notation for metadata fields

Example: ?metadata.type=video&metadata.status=ready

Sorting: Specify field and direction

Example: ?sort_field=metadata.created_at&sort_direction=desc
Direction: asc (ascending) or desc (descending), defaults to asc

Pagination: Cursor-based for efficient deep pagination

First page: ?limit=100 (omit cursor)
Next pages: ?limit=100&cursor=
Use next_cursor from response to navigate
No limit on pagination depth

Total Count: Optional (expensive operation)

Use ?include_total=true to get total count
Adds 50-200ms to response time
Returns total, page, page_size, total_pages fields in pagination response

POST

buckets

{bucket_identifier}

objects

list

List Objects

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "search": "<string>",
  "select": [
    "metadata",
    "status",
    "created_at"
  ],
  "return_presigned_urls": false
}
'

{
  "results": [
    {
      "bucket_id": "<string>",
      "object_id": "<string>",
      "key_prefix": "<string>",
      "blobs": [
        {
          "property": "<string>",
          "blob_id": "<string>",
          "key_prefix": "/videos/video.mp4",
          "properties": {},
          "presigned_url": "<string>",
          "details": {
            "filename": "<string>",
            "size_bytes": 123,
            "mime_type": "<string>",
            "hash": "<string>"
          }
        }
      ],
      "source_details": [
        {
          "source_id": "<string>"
        }
      ],
      "status": "DRAFT",
      "error": "Failed to process object: Object not found",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "document_count": 123
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "stats": {
    "total_objects": 0,
    "total_blobs": 0,
    "avg_blobs_per_object": 0,
    "objects_by_status": {}
  }
}

Headers

Authorization

string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

authorization

string

X-Namespace

string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

bucket_identifier

string

required

The unique identifier of the bucket.

Query Parameters

limit

integer | null

Required range: 1 <= x <= 1000

offset

integer | null

Required range: 0 <= x <= 10000

cursor

string | null

include_total

boolean

default:false

Body

application/json

Request model for listing objects in a bucket.

filters

LogicalOperator · object

Filters to apply to the object list

Show child attributes

sort

SortOption · object

Sort options for the object list

Show child attributes

string | null

Search term to filter objects by key or metadata

select

string[] | null

OPTIONAL. List of fields to include in the response. Supports dot notation for nested fields (e.g., 'metadata.title', 'status'). When specified, only the selected fields will be returned in the object results, reducing response size. System fields like 'object_id' and 'bucket_id' are always included. Use this to optimize response size when working with large objects.

Example:

["metadata", "status", "created_at"]

return_presigned_urls

boolean | null

default:false

Generate fresh presigned download URLs for all blobs with S3 storage. When true, each blob will include a 'presigned_url' in its properties. URLs expire after 1 hour.

Response

Successful Response

Response model for listing objects in a bucket.

results

ObjectResponse · object[]

required

List of objects matching the query

Show child attributes

pagination

PaginationResponse · object

required

Pagination information

Show child attributes

stats

ObjectListStats · object

Aggregate statistics across all objects in the result

Show child attributes

Partially Update Object Aggregate Objects