GET
/
v1
/
clusters
/
{cluster_identifier}
Get Cluster
curl --request GET \
  --url https://api.mixpeek.com/v1/clusters/{cluster_identifier}
{
  "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
  }
}

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.

Path Parameters

​
cluster_identifier
string
required

Cluster ID or name

Response

Successful Response

Cluster metadata stored in MongoDB.

​
collection_ids
string[]
required

Collections to cluster together

Minimum length: 1
​
cluster_name
string | null

Optional human-friendly name for the clustering job

​
cluster_type
enum<string>

Vector or attribute clustering

Available options:
vector,
attribute
​
vector_config
object | null

Required when cluster_type is 'vector' Configuration for vector-based clustering.

​
attribute_config
object | null

Required when cluster_type is 'attribute' Configuration for attribute-based clustering.

​
llm_labeling
object

Configuration for LLM-based cluster labeling

​
cluster_id
string

Unique cluster identifier

​
parquet_path
string | null

S3 path to parquet files with cluster data

​
members_key
string | null

S3 key to members.parquet (if saved)

​
num_clusters
integer | null

Number of clusters found

​
cluster_stats
object | null

Clustering quality metrics Basic clustering quality metrics.

​
status
enum<string>

Clustering job status

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT
​
task_id
string | null

Associated task ID for clustering job

​
created_at
string<date-time>

When the cluster was created

​
updated_at
string<date-time>

When the cluster was last updated