Search by reference image
curl --request POST \
--url http://localhost:6699/api/v1/search/image \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"image_path": "<string>",
"cache_dir": "<string>",
"query": "<string>",
"exclude": [
"<string>"
],
"media_paths": [
"<string>"
],
"max_results": 50,
"search_all": false
}
'import requests
url = "http://localhost:6699/api/v1/search/image"
payload = {
"image_path": "<string>",
"cache_dir": "<string>",
"query": "<string>",
"exclude": ["<string>"],
"media_paths": ["<string>"],
"max_results": 50,
"search_all": False
}
headers = {
"X-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
image_path: '<string>',
cache_dir: '<string>',
query: '<string>',
exclude: ['<string>'],
media_paths: ['<string>'],
max_results: 50,
search_all: false
})
};
fetch('http://localhost:6699/api/v1/search/image', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "6699",
CURLOPT_URL => "http://localhost:6699/api/v1/search/image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'image_path' => '<string>',
'cache_dir' => '<string>',
'query' => '<string>',
'exclude' => [
'<string>'
],
'media_paths' => [
'<string>'
],
'max_results' => 50,
'search_all' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-License-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:6699/api/v1/search/image"
payload := strings.NewReader("{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-License-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:6699/api/v1/search/image")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/search/image")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}Search
Search by reference image
Finds moments visually similar to a reference image. Optionally combine with a text query to refine results. Results are ordered best-first.
POST
/
search
/
image
Search by reference image
curl --request POST \
--url http://localhost:6699/api/v1/search/image \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"image_path": "<string>",
"cache_dir": "<string>",
"query": "<string>",
"exclude": [
"<string>"
],
"media_paths": [
"<string>"
],
"max_results": 50,
"search_all": false
}
'import requests
url = "http://localhost:6699/api/v1/search/image"
payload = {
"image_path": "<string>",
"cache_dir": "<string>",
"query": "<string>",
"exclude": ["<string>"],
"media_paths": ["<string>"],
"max_results": 50,
"search_all": False
}
headers = {
"X-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
image_path: '<string>',
cache_dir: '<string>',
query: '<string>',
exclude: ['<string>'],
media_paths: ['<string>'],
max_results: 50,
search_all: false
})
};
fetch('http://localhost:6699/api/v1/search/image', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "6699",
CURLOPT_URL => "http://localhost:6699/api/v1/search/image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'image_path' => '<string>',
'cache_dir' => '<string>',
'query' => '<string>',
'exclude' => [
'<string>'
],
'media_paths' => [
'<string>'
],
'max_results' => 50,
'search_all' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-License-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:6699/api/v1/search/image"
payload := strings.NewReader("{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-License-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:6699/api/v1/search/image")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/search/image")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"image_path\": \"<string>\",\n \"cache_dir\": \"<string>\",\n \"query\": \"<string>\",\n \"exclude\": [\n \"<string>\"\n ],\n \"media_paths\": [\n \"<string>\"\n ],\n \"max_results\": 50,\n \"search_all\": false\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}Authorizations
Jumper Pro license key passed via header
Body
application/json
Absolute path to the reference image
Optional text query to combine with the image
Softly push down results that match these visual concepts. Requires query text.
Response
200 - application/json
Search results ordered by visual similarity
Show child attributes
Show child attributes
Last modified on July 1, 2026
Was this page helpful?
⌘I

