Skip to main content
POST
/
v1
/
clusters
/
{cluster_id}
/
data
Stream Cluster Data
curl --request POST \
  --url https://api.mixpeek.com/v1/clusters/{cluster_id}/data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '{
  "cluster_id": "cl_123",
  "include_centroids": true,
  "include_members": true,
  "limit": 100,
  "offset": 0
}'
{
  "cluster_id": "<string>",
  "centroids": [
    {
      "cluster_label": "<string>",
      "centroid_vector": [
        123
      ],
      "num_members": 123,
      "metadata": {}
    }
  ],
  "members": [
    {
      "document_id": "<string>",
      "cluster_label": "<string>",
      "distance_to_centroid": 123,
      "coordinates": [
        123
      ],
      "metadata": {}
    }
  ],
  "total_clusters": 123,
  "total_members": 123
}

Authorizations

Authorization
string
header
required

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.

Headers

Authorization
string
required

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 sk_live_abc123def456"

"Bearer sk_test_xyz789"

X-Namespace
string
required

REQUIRED: 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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

cluster_id
string
required

Cluster ID

Body

application/json

Request to stream cluster data from parquet files.

cluster_id
string | null

Cluster ID to fetch data for

include_centroids
boolean
default:true

Include cluster centroids

include_members
boolean
default:false

Include cluster members

limit
integer | null

Limit number of records

offset
integer
default:0

Offset for pagination

Response

Successful Response

Response with cluster data from parquet.

cluster_id
string
required
total_clusters
integer
required
total_members
integer
required
centroids
ClusterCentroidData · object[]
members
ClusterMemberData · object[]