VisionAPI ReferenceV2

Search

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

OR
AuthorizationBearer
Bearer token authentication via Authorization header

Request

This endpoint expects an object.
querystringRequired>=1 character

Search query — natural language for semantic, literal text for text

strategyenumOptional

‘semantic’ (embedding similarity) or ‘text’ (literal substring match)

Allowed values:
fieldslist of enums or nullOptional

Which data to search. For text: ‘transcript’, ‘captions’ (default: both). Ignored for semantic.

Allowed values:
video_idslist of strings or nullOptional
Scope to specific video IDs
group_idslist of strings or nullOptional
Scope to videos in specific groups
thresholdenumOptional

Confidence filter: high, medium, low, none. Only affects semantic strategy.

Allowed values:
rerankbooleanOptionalDefaults to false

Apply embedding-based reranking (semantic only, slightly slower)

filterobject or nullOptional

Metadata filters (duration, width, height)

datetime_fromdatetime or nullOptional
Start of an explicit UTC datetime range for semantic search
datetime_todatetime or nullOptional
End of an explicit UTC datetime range for semantic search
timestamp_fromdouble or nullOptional>=0

Start of an explicit in-video timestamp range in seconds

timestamp_todouble or nullOptional>=0

End of an explicit in-video timestamp range in seconds

page_limitintegerOptional<=50Defaults to 10

Results per page (max 50)

page_tokenstring or nullOptional
Pagination token from a previous response
include_reportbooleanOptionalDefaults to false

Generate LLM summary of results (semantic only)

Response

Successful Response
datalist of objects
search_poolobject
next_page_tokenstring or null
reportstring or null

LLM-generated summary (when include_report=true, semantic only)