Skip to main content
POST
/
search
/
text
Search by text query
curl --request POST \
  --url http://localhost:6699/api/v1/search/text \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "query": "man pointing a finger",
  "cache_dir": "<string>",
  "media_paths": [
    "<string>"
  ],
  "max_results": 50,
  "text_weight": 1,
  "exclude": [
    "<string>"
  ],
  "search_all": false,
  "people_filter": [
    {
      "cluster_job_name": "<string>",
      "person_name": "<string>",
      "cluster_id": "<string>"
    }
  ]
}
'
{
  "matches": [
    {
      "frame_idx": "<string>",
      "timestamp": "<string>",
      "image": "aSDinaTvuI8gbWludGxpZnk=",
      "scene_start_timestamp": "<string>",
      "scene_end_timestamp": "<string>",
      "original_index": 123,
      "hash_str": "<string>",
      "video_path": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getjumper.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

Response

200 - application/json

Search results ordered by relevance

matches
object[]
Last modified on May 7, 2026