POST
/
v1
/
clusters
/
list
List Clusters
curl --request POST \
  --url https://api.mixpeek.com/v1/clusters/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>"
}'
{
  "results": [
    {
      "cluster_name": "products_clip_hdbscan",
      "cluster_type": "vector",
      "collection_ids": [
        "col_products_v1",
        "col_products_v2"
      ],
      "llm_labeling": {
        "enabled": true,
        "model_name": "gpt-4"
      },
      "vector_config": {
        "clustering_method": "hdbscan",
        "feature_extractor_name": "clip_vit_l_14",
        "hdbscan_parameters": {
          "min_cluster_size": 10,
          "min_samples": 5
        },
        "sample_size": 5000
      }
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

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.

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request model for listing clusters.

Response

200
application/json

Successful Response

Response model for listing clusters.