People

Beta — this operation may change on 30 days notice. See versioning.

Returns the people in the workspace, most-photographed first, each with the number of faces assigned to it and the number of suggestions waiting for review.

unnamed=true returns only the clusters nobody has named yet, and needs_review=true only those with suggestions pending — the two queues the review UI is built around.

Beta — this operation may change on 30 days notice. See versioning.

Beta — this operation may change on 30 days notice. See versioning.

Releases every face assigned to this person and then deactivates it. The faces and the photos survive — they go back to being unassigned detections, available to be grouped again.

Beta — this operation may change on 30 days notice. See versioning.

Only files the caller may read are returned — the file's own access rules still apply, so two people looking at the same person can see different photos.

Beta — this operation may change on 30 days notice. See versioning.

Recomputes the references this person is matched against, after their assignments have changed enough to be worth it. Runs in the background: a request made while one is already running answers 202 rather than starting a second.

Beta — this operation may change on 30 days notice. See versioning.

The detection must already belong to this person.

Beta — this operation may change on 30 days notice. See versioning.

Runs one vision comparison of the person's reference faces against each unverified candidate and records a match, no_match or unsure verdict — it catches what the face embeddings cannot.

It decides nothing on its own: verdicts come back through the suggestion list, and a no_match withholds that suggestion. Idempotent, and already-verified candidates are skipped, so calling it twice costs nothing.

Beta — this operation may change on 30 days notice. See versioning.

Assigns one detected face. Omit fp_id and a new person is created for it — optionally named with fp_name — which is how a face is named for the first time.

Beta — this operation may change on 30 days notice. See versioning.

Moves every face from source_id onto target_id and retires the source. This is the fix for one person having been split across two clusters.

Beta — this operation may change on 30 days notice. See versioning.

Faces the matcher believes belong to someone already named, closest match first, waiting for a yes or no. Filter to one person with fp_id.

Suggestions that plainly contradict the person are withheld rather than shown and rejected: a gender estimate against confidently-gendered references, an age far from the person's median, or a no_match verdict from the vision check. Anything already verified carries its verdict here.

Beta — this operation may change on 30 days notice. See versioning.

Beta — this operation may change on 30 days notice. See versioning.

Beta — this operation may change on 30 days notice. See versioning.

Applies one action — confirm or reject — to every id in fd_ids. A suggestion someone else already resolved is skipped rather than failing the batch, so the counts in the response are the truth about what this call did.

Beta — this operation may change on 30 days notice. See versioning.

Detaches a face from its person and leaves it as an unassigned detection.