Sign in
search > search

Text to Image by Person Search

Search for video keyframes that match a text query and contain a specific enrolled person — for example, Jane Doe at a press conference. Specify the person via either person_ids or person_names_or_aliases.The person must already be enrolled in your organization. Returns matching assets plus a video-level list aggregated by best matching keyframe score.

post/api/v1/search/text-to-image/by-person

Headers

Authorizationstring required

Bearer authentication

Request body

dataset_idstring uuid required

The unique identifier for the dataset

offsetinteger

Starting index to return

limitinteger

Max number of items to return

moderation_score_type'probability' | 'level'

Score type returned by the moderation service.

  • PROBABILITY: Scores in range 0-1 (uses BGE Reranker model)
  • LEVEL: Scores in range 0-5 (uses OpenAI model)
text_querystring required

The text query to search for

negative_textstring nullable

Optional text describing what to exclude from search results. Steers the query embedding away from this direction.

person_idsstring[] nullable

List of person IDs to filter results by. Currently only a single person_id is supported.

person_names_or_aliasesstring[] nullable

List of person names/aliases to filter results by. Currently only a single person name is supported.

asset_type'image' | 'keyframe' required
skip_moderationboolean

Skip content moderation if enabled

Response

Successful Response

Changes

Changed in 1 of the 2 revisions of this API.4

  • 1223758be9ba4See the full diff
    • ●

      the limit request property's max was set to 1000.00

      request-property-max-set

    • ●

      the offset request property's max was set to 9223372036854775808.00

      request-property-max-set

    • ●

      the limit request property's min was set to 1.00

      request-property-min-set

    • ●

      the offset request property's min was set to 0.00

      request-property-min-set