v3

latestOpenAPI 3.1.02026-07-31112356215.0 KB
identity

Search identities

Search the team's identities (plus global identities) for matches against a media sample. Supports audio (voice matching) and image (face/visual matching); video is not yet supported for synchronous search.

post/identity/search

Headers

Authorizationstring required

Request body

urlstring uri

URL to the media sample (one of url, file, signed_id is required)

signed_idstring

Signed ID from a secure upload

modality'audio' | 'image'

Inferred from the media's content type when omitted (defaults to audio)

top_kinteger

Response

Search results

successboolean
modality'audio' | 'image'
itemobject

Matches keyed by identity UUID. distance is a 0-100 match score (higher is closer; an identical sample scores 100). Image matches include score_type "cosine".