v2
latestOpenAPI 3.1.02026-08-07262688.0 KBSearch N videos
Do simple video listing or do advanced video search with filters, sorting, pagination, facets and counting
Query parameters
Query filtering formula, must be url-encoded. Similarity uses i~, i~~, i~~~ for semantic similarity search and i=, i==, i=== for visual duplicate-detection search. i==== requests an additional, more precise duplicate-verification pass on the top candidate, slightly slower than the other comparisons; this mode is currently restricted to selected tenants.
Query filtering formula, must be url-encoded. Similarity uses i~, i~~, i~~~ for semantic similarity search and i=, i==, i=== for visual duplicate-detection search. i==== requests an additional, more precise duplicate-verification pass on the top candidate, slightly slower than the other comparisons; this mode is currently restricted to selected tenants.
Page number. 1 is the first page.
Page number. 1 is the first page.
Maximum number of videos to return per page
Maximum number of videos to return per page
Sorting criterion. Note that sort_by=similarity only works if there are present "similary filters" on the Query Filtering Formula.
Sorting criterion. Note that sort_by=similarity only works if there are present "similary filters" on the Query Filtering Formula.
Ascending or descending sorting.
Ascending or descending sorting.
Array of fields to retrieve. Example: fields=image_id&fields=src
Array of fields to retrieve. Example: fields=image_id&fields=src
Array of facets to retrieve. Example: facets=author&facets=keywords
Array of facets to retrieve. Example: facets=author&facets=keywords
Include total hit count?
Include total hit count?
Language code.
Language code.
Response
Successful Response
Example response
{
"results": [
{
"thumbnail_url": "https://cdn.example.com/video/thumb.jpg",
"preview_url": "https://cdn.example.com/video/preview.mp4",
"img_src": "https://cdn.example.com/video/thumb.jpg",
"img_zoom": "https://cdn.example.com/video/preview.mp4",
"date": "2024-10-19"
}
]
}