VisionAPI ReferenceVideo Search

Search Videos

Embedding-based search with temporal extraction support.

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
thresholddouble or nullOptional
max_resultsintegerOptional<=200Defaults to 10
video_idslist of strings or nullOptional
group_idslist of strings or nullOptional
search_demobooleanOptionalDefaults to false
use_llm_rerankbooleanOptionalDefaults to false
use_embeds_rerankbooleanOptionalDefaults to true
add_ocr_to_captionbooleanOptionalDefaults to false
datetime_fromstring or nullOptional

Filter from datetime (ISO 8601 format, e.g., 2024-01-15T10:00:00Z)

datetime_tostring or nullOptional

Filter to datetime (ISO 8601 format, e.g., 2024-01-15T18:00:00Z)

timestamp_fromdouble or nullOptional

Filter from video timestamp in seconds (relative to video start)

timestamp_todouble or nullOptional

Filter to video timestamp in seconds (relative to video start)

generate_reportbooleanOptionalDefaults to false
Whether to generate a report and explanations for the search results

Response

Successful Response
resultslist of objects or null
List of search results
reportstring or null
Report summarizing the search results