Skip to main content
GET
/
faces
/
clusters
List face clustering jobs
curl --request GET \
  --url http://localhost:6699/api/v1/faces/clusters \
  --header 'X-License-Key: <api-key>'
import requests

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

headers = {"X-License-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-License-Key': '<api-key>'}};

fetch('http://localhost:6699/api/v1/faces/clusters', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-License-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:6699/api/v1/faces/clusters")
.header("X-License-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-License-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "cluster_jobs": [
    "<string>"
  ],
  "jobs": [
    {
      "name": "<string>",
      "total_entries": 123,
      "num_clusters": 123,
      "noise_entries": 123,
      "cluster_ids": [
        "<string>"
      ],
      "face_storage_version": 123,
      "media_hashes": [
        "<string>"
      ]
    }
  ]
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Query Parameters

cache_dir
string
required

Response

200 - application/json

Cluster job list

cluster_jobs
string[]

Job names

jobs
object[]
Last modified on July 1, 2026