API ReferenceIdentity

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.

Authentication

AuthorizationBearer
API token from https://app.resemble.ai/account/api

Request

This endpoint expects an object.
urlstringOptionalformat: "uri"

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

signed_idstringOptional
Signed ID from a secure upload
modalityenumOptional

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

Allowed values:
top_kintegerOptional1-20Defaults to 1

Response

Search results
successboolean
modalityenum
itemmap from strings to objects

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”.

Errors

400
Bad Request Error
422
Unprocessable Entity Error