Sign in

v51

latestOpenAPI 3.0.3AGPL-3raw.githubusercontent.com2026-08-0171267287.4 KB
Graph
Entity

post/entities/embeddings/clusters

Headers

X-Authenticated-User-Actor-Idstring uuid required

The ID of the actor which is used to authorize the request

Request body

clusterCountinteger required

Desired number of clusters.

Clamped to the number of entities with embeddings when that is smaller.

dimensioninteger

Embedding dimension after matryoshka truncation.

Must be a positive multiple of 8; values above 512 are rejected. Defaults to 256.

entityIdsEntityId[] required
seedinteger nullable

Seed for the random number generator used in clustering.

If not provided, a random seed will be used.

Example request

{
  "dimension": 256
}

Response

Clusters of entities by embedding similarity

inertianumber float required

Sum of squared chord distances from every clustered entity to its assigned centroid. Lower is tighter; comparable across runs over the same entities, e.g. to choose a cluster count. 0.0 when nothing was clustered.

missingEmbeddingsEntityId[] required

Entities from the request that were not clustered (either because no embedding exists, or because the actor lacks permission to view the entity).