Skip to main content
POST
Search by text query

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Body

application/json
query
string
required

Natural-language search query

Example:

"man pointing a finger"

cache_dir
string
required
media_paths
string[]

Restrict search to these files (ignored if search_all is true)

max_results
integer
default:50
text_weight
number
default:1

Weight of text similarity (advanced)

exclude
string[]

Softly push down results that match these visual concepts.

search_all
boolean
default:false

Search across all loaded media instead of just media_paths

people_filter
object[]

Only return matches containing these people. Each item needs cluster_job_name plus either person_name or cluster_id.

people_filter_mode
enum<string>
default:and

Match mode for multiple people. "and" requires every selected person in the same frame; "or" matches frames containing any selected person.

Available options:
or,
and
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.

Response

200 - application/json

Search results ordered by relevance

matches
object[]
Last modified on July 14, 2026