Skip to main content
PUT
/
faces
/
clusters
/
names
Rename clusters
curl --request PUT \
  --url http://localhost:6699/api/v1/faces/clusters/names \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "<string>",
  "cluster_job_name": "<string>",
  "assignments": [
    {
      "cluster_id": "<string>",
      "name": "<string>"
    }
  ]
}
'
{
  "updated": 123,
  "changes": {}
}

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
assignments
object[]
required

Response

200 - application/json

Names updated

updated
integer

Number of clusters renamed

changes
object

Map of cluster_id to new name

Last modified on February 18, 2026