Skip to main content
GET
/
v1
/
clusters
/
{cluster_id}
/
executions
Get Latest Cluster Execution
curl --request GET \
  --url https://api.mixpeek.com/v1/clusters/{cluster_id}/executions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "run_id": "<string>",
  "cluster_id": "<string>",
  "status": "pending",
  "num_clusters": 123,
  "num_points": 123,
  "metrics": {
    "silhouette_score": 123,
    "davies_bouldin_index": 123,
    "calinski_harabasz_score": 123
  },
  "centroids": [
    {
      "cluster_id": "<string>",
      "num_members": 123,
      "label": "<string>",
      "summary": "<string>",
      "keywords": [
        "<string>"
      ]
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>"
}

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

Response

Successful Response

Results of the most recent clustering execution for a cluster.

​
run_id
string
required

Unique identifier for this clustering run

​
cluster_id
string
required

Parent cluster ID

​
status
enum<string>
required

Execution status

Available options:
pending,
processing,
completed,
failed
​
num_clusters
integer
required

Number of clusters found

​
num_points
integer
required

Total documents/points clustered

​
created_at
string<date-time>
required

When execution started

​
metrics
object | null

Quality metrics Quality metrics for a clustering execution.

​
centroids
ClusterExecutionCentroid · object[] | null

Centroid information

​
completed_at
string<date-time> | null

When execution completed

​
error_message
string | null

Error message if failed