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
}
'
import requests

url = "http://localhost:6699/api/v1/faces/clusters/samples"

payload = {
"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
}
headers = {
"X-License-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};

fetch('http://localhost:6699/api/v1/faces/clusters/samples', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "6699",
CURLOPT_URL => "http://localhost:6699/api/v1/faces/clusters/samples",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-License-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://localhost:6699/api/v1/faces/clusters/samples"

payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"limit_per_cluster\": 12,\n \"min_cluster_size\": 1,\n \"max_cluster_size\": 1000000000,\n \"max_clusters\": 100,\n \"include_noise\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-License-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:6699/api/v1/faces/clusters/samples")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"limit_per_cluster\": 12,\n \"min_cluster_size\": 1,\n \"max_cluster_size\": 1000000000,\n \"max_clusters\": 100,\n \"include_noise\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:6699/api/v1/faces/clusters/samples")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"limit_per_cluster\": 12,\n \"min_cluster_size\": 1,\n \"max_cluster_size\": 1000000000,\n \"max_clusters\": 100,\n \"include_noise\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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 July 1, 2026