Skip to main content
POST
/
search
/
frame
Search by video frame
curl --request POST \
  --url http://localhost:6699/api/v1/search/frame \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "media_path": "<string>",
  "time_seconds": 123,
  "cache_dir": "<string>",
  "query": "<string>",
  "media_paths": [
    "<string>"
  ],
  "max_results": 50,
  "search_all": false
}
'
{
  "matches": [
    {
      "frame_index": 123,
      "timestamp": "<string>",
      "similarity": 123,
      "hash_str": "<string>",
      "video_path": "<string>"
    }
  ]
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

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

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

Response

200 - application/json

Search results ordered by visual similarity

matches
object[]
Last modified on February 18, 2026