curl --request POST \
--url http://localhost:6699/api/v1/metadata/facets \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"cache_dir": "<string>",
"scope": {
"mode": "paths",
"media_type": "any",
"media_paths": [
"<string>"
],
"hash_strs": [
"<string>"
],
"expected_count": 123
},
"media_type": "any",
"media_paths": [
"<string>"
],
"hash_strs": [
"<string>"
],
"search_all": false,
"expected_count": 123,
"filters": []
}
'import requests
url = "http://localhost:6699/api/v1/metadata/facets"
payload = {
"cache_dir": "<string>",
"scope": {
"mode": "paths",
"media_type": "any",
"media_paths": ["<string>"],
"hash_strs": ["<string>"],
"expected_count": 123
},
"media_type": "any",
"media_paths": ["<string>"],
"hash_strs": ["<string>"],
"search_all": False,
"expected_count": 123,
"filters": []
}
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({
cache_dir: '<string>',
scope: {
mode: 'paths',
media_type: 'any',
media_paths: ['<string>'],
hash_strs: ['<string>'],
expected_count: 123
},
media_type: 'any',
media_paths: ['<string>'],
hash_strs: ['<string>'],
search_all: false,
expected_count: 123,
filters: []
})
};
fetch('http://localhost:6699/api/v1/metadata/facets', 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/metadata/facets",
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([
'cache_dir' => '<string>',
'scope' => [
'mode' => 'paths',
'media_type' => 'any',
'media_paths' => [
'<string>'
],
'hash_strs' => [
'<string>'
],
'expected_count' => 123
],
'media_type' => 'any',
'media_paths' => [
'<string>'
],
'hash_strs' => [
'<string>'
],
'search_all' => false,
'expected_count' => 123,
'filters' => [
]
]),
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/metadata/facets"
payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\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/metadata/facets")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/metadata/facets")
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 \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"facets": [
{
"id": "video.codec",
"label": "Codec",
"group": "Video",
"path": [
"<string>"
],
"options": [
{
"value": "<string>",
"label": "<string>",
"count": 123,
"meta": {}
}
],
"min": 123,
"max": 123
}
],
"coverage": {
"scope_count": 123,
"indexed_count": 123,
"missing_count": 123
},
"active_filter_count": 123,
"warning": "<string>"
}Get metadata filter facets
Returns curated metadata filter facets and coverage for a searchable scope.
Call this before search to render available filter options, then pass selected
filters to visual or transcript search using metadata_filter_request.
For mode: global, facets are scoped to loaded searchable media for the
requested media_type, not every row in the local metadata database.
curl --request POST \
--url http://localhost:6699/api/v1/metadata/facets \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"cache_dir": "<string>",
"scope": {
"mode": "paths",
"media_type": "any",
"media_paths": [
"<string>"
],
"hash_strs": [
"<string>"
],
"expected_count": 123
},
"media_type": "any",
"media_paths": [
"<string>"
],
"hash_strs": [
"<string>"
],
"search_all": false,
"expected_count": 123,
"filters": []
}
'import requests
url = "http://localhost:6699/api/v1/metadata/facets"
payload = {
"cache_dir": "<string>",
"scope": {
"mode": "paths",
"media_type": "any",
"media_paths": ["<string>"],
"hash_strs": ["<string>"],
"expected_count": 123
},
"media_type": "any",
"media_paths": ["<string>"],
"hash_strs": ["<string>"],
"search_all": False,
"expected_count": 123,
"filters": []
}
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({
cache_dir: '<string>',
scope: {
mode: 'paths',
media_type: 'any',
media_paths: ['<string>'],
hash_strs: ['<string>'],
expected_count: 123
},
media_type: 'any',
media_paths: ['<string>'],
hash_strs: ['<string>'],
search_all: false,
expected_count: 123,
filters: []
})
};
fetch('http://localhost:6699/api/v1/metadata/facets', 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/metadata/facets",
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([
'cache_dir' => '<string>',
'scope' => [
'mode' => 'paths',
'media_type' => 'any',
'media_paths' => [
'<string>'
],
'hash_strs' => [
'<string>'
],
'expected_count' => 123
],
'media_type' => 'any',
'media_paths' => [
'<string>'
],
'hash_strs' => [
'<string>'
],
'search_all' => false,
'expected_count' => 123,
'filters' => [
]
]),
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/metadata/facets"
payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\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/metadata/facets")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/metadata/facets")
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 \"cache_dir\": \"<string>\",\n \"scope\": {\n \"mode\": \"paths\",\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"expected_count\": 123\n },\n \"media_type\": \"any\",\n \"media_paths\": [\n \"<string>\"\n ],\n \"hash_strs\": [\n \"<string>\"\n ],\n \"search_all\": false,\n \"expected_count\": 123,\n \"filters\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"facets": [
{
"id": "video.codec",
"label": "Codec",
"group": "Video",
"path": [
"<string>"
],
"options": [
{
"value": "<string>",
"label": "<string>",
"count": 123,
"meta": {}
}
],
"min": 123,
"max": 123
}
],
"coverage": {
"scope_count": 123,
"indexed_count": 123,
"missing_count": 123
},
"active_filter_count": 123,
"warning": "<string>"
}Authorizations
Jumper Pro license key passed via header
Body
Show child attributes
Show child attributes
Used when scope is omitted.
visual, speech, any Used to build a path scope when scope is omitted.
Hashes aligned with media_paths when scope is omitted.
Build a global scope when scope is omitted.
Optional count used for coverage reporting when scope is omitted.
Usually empty for option loading. Included only for active-filter count reporting.
Show child attributes
Show child attributes
Was this page helpful?

