Skip to main content
POST
Search within videos

Authorizations

Authorization
string
header
required

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

Body

application/json
collection_id
string
required

The collection UUID to search within

Example:

"c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l"

search_term
string
required

The text query used for searching

Example:

"sunset beach"

media_ids
string[]

A list of media UUIDs to filter the search

Example:

"m1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l"

similarity_threshold
number
default:0.28

The minimum similarity score required to presented in search results

Example:

0.28

offset
integer
default:0

The pagination offset for search results

Example:

10

limit
integer
default:30

The maximum number of search results to return

Example:

30

configs
SearchConfigs · object

Additional configuration options for the search, such as removing false positives

filter
Filter · object | null

Optional filters to apply to the search results. For now, it only supports matching value on metadata fields

Example:

Response

Successful Response

scenes
Scene · object[]
required
metadata
Metadata · object
required