Skip to main content
POST
Search by video frame

Authorizations

X-License-Key
string
header
required

Raw Jumper Pro license key on every authenticated request, without a Bearer prefix

Body

application/json
media_path
string
required

Video to extract the reference frame from

time_seconds
number
required

Timestamp in seconds for the reference frame

cache_dir
string
required
query
string

Optional text query to combine with the frame

exclude
string[]

Softly push down results that match these visual concepts. Requires query text.

media_paths
string[]
max_results
integer
default:50
search_all
boolean
default:false
metadata_filter_request
object

Metadata filters to apply to a search. If scope is omitted, Jumper derives it from the endpoint's search_all and media_paths values.

segments_to_frame_indices
object

Media-path or media-hash keys mapped to half-open [start_frame, end_frame) ranges, or lists of ranges, on Jumper's 1 FPS analysis grid. Keys must be inside the selected media scope.

Response

Search results ordered by visual similarity

matches
object[]
toast_warning
string

Present when some analysis or frames could not be read; matches contain the available results from other files.

Last modified on October 11, 2026