Skip to main content
POST
/
faces
/
clusters
/
samples
Get sample face images per cluster
curl --request POST \
  --url http://localhost:6699/api/v1/faces/clusters/samples \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "<string>",
  "cluster_job_name": "<string>",
  "limit_per_cluster": 12,
  "min_cluster_size": 1,
  "max_cluster_size": 1000000000,
  "max_clusters": 100,
  "include_noise": false
}
'
{
  "cluster_job_name": "<string>",
  "num_clusters": 123,
  "num_clusters_after_filter": 123,
  "total_entries": 123,
  "clusters": [
    {
      "cluster_id": "<string>",
      "name": "<string>",
      "size": 123,
      "sample_faces": [
        "aSDinaTvuI8gbWludGxpZnk="
      ]
    }
  ],
  "noise_size": 123,
  "noise_sample": [
    "aSDinaTvuI8gbWludGxpZnk="
  ]
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Body

application/json
cache_dir
string
required
cluster_job_name
string
required
limit_per_cluster
integer
default:12
min_cluster_size
integer
default:1
max_cluster_size
integer
default:1000000000
max_clusters
integer
default:100
include_noise
boolean
default:false

Include unassigned faces in response

Response

200 - application/json

Cluster samples

cluster_job_name
string
num_clusters
integer
num_clusters_after_filter
integer
total_entries
integer
clusters
object[]
noise_size
integer

Only present if include_noise was true

noise_sample
string<byte>[]

Only present if include_noise was true

Last modified on February 18, 2026