Sign in

v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB
search > search

Text to Keyframes Search

Search across all video frames in a dataset using a natural-language query. Returns the keyframes that best match the description.Use this when you want all the keyframe-level results from your videos rather than one-result-per-video.

post/api/v1/search/text-to-keyframes

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.

asset_type'image' | 'video'
skip_moderationboolean

Skip content moderation if enabled

Response

Successful Response