API ReferenceSearchSearch

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
dataset_idstringRequiredformat: "uuid"
The unique identifier for the dataset
text_querystringRequired
The text query to search for
offsetintegerOptional0-9223372036854776000Defaults to 0
Starting index to return
limitintegerOptional1-1000Defaults to 100
Max number of items to return
metadata_filtersobject or nullOptional
List of metadata filters to apply to the search
moderation_score_typeenumOptional

Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that.

negative_textstring or nullOptional
Optional text describing what to exclude from search results. Steers the query embedding away from this direction.
asset_typeenum or nullOptional
The asset type to filter results by. If no asset type is selected the endpoint will search over images and videos
skip_moderationbooleanOptionalDefaults to false
Skip content moderation if enabled

Response

Successful Response
datalist of objects

Errors

422
Unprocessable Entity Error