Skip to main content
GET
/
v1
/
clusters
/
{cluster_id}
/
groups
List Cluster Groups
curl --request GET \
  --url https://api.mixpeek.com/v1/clusters/{cluster_id}/groups
{
  "cluster_id": "<string>",
  "total_groups": 123,
  "total_documents": 123,
  "groups": [
    {
      "cluster_id": "<string>",
      "member_count": 123,
      "label": "<string>",
      "summary": "<string>",
      "keywords": [
        "<string>"
      ]
    }
  ],
  "run_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

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

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_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

​
cluster_id
string
required

Cluster ID

Response

Successful Response

Response containing all groups for a cluster.

​
cluster_id
string
required
​
total_groups
integer
required
​
total_documents
integer
required
​
groups
ClusterGroup · object[]
required
​
run_id
string | null