List hierarchical summary collections
curl --request POST \
--url http://localhost:6699/api/v1/summaries/collections \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"cache_dir": "<string>",
"include_members": false,
"collection_id": "<string>",
"member_limit": 100
}
'import requests
url = "http://localhost:6699/api/v1/summaries/collections"
payload = {
"cache_dir": "<string>",
"include_members": False,
"collection_id": "<string>",
"member_limit": 100
}
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>',
include_members: false,
collection_id: '<string>',
member_limit: 100
})
};
fetch('http://localhost:6699/api/v1/summaries/collections', 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/summaries/collections",
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>',
'include_members' => false,
'collection_id' => '<string>',
'member_limit' => 100
]),
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/summaries/collections"
payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\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/summaries/collections")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/summaries/collections")
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 \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"schema_version": "<string>",
"collections": [
{
"id": "<string>",
"name": "<string>",
"media_count": 123,
"analysis_count": 123,
"description": "<string>",
"updated_at": "<string>",
"members": [
{
"summary_ref": "<string>",
"hash_str": "<string>",
"media_path": "<string>",
"media_basename": "<string>",
"analysis_id": "<string>",
"analysis_name": "<string>"
}
],
"members_truncated": true
}
]
}{
"error": "<string>"
}Summaries
List hierarchical summary collections
Returns compact collection metadata and counts without enumerating members by default. Pass collection_id with include_members=true to return every compact registry member of only that collection, without loading summary text or applying the legacy 500-member cap.
POST
/
summaries
/
collections
List hierarchical summary collections
curl --request POST \
--url http://localhost:6699/api/v1/summaries/collections \
--header 'Content-Type: application/json' \
--header 'X-License-Key: <api-key>' \
--data '
{
"cache_dir": "<string>",
"include_members": false,
"collection_id": "<string>",
"member_limit": 100
}
'import requests
url = "http://localhost:6699/api/v1/summaries/collections"
payload = {
"cache_dir": "<string>",
"include_members": False,
"collection_id": "<string>",
"member_limit": 100
}
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>',
include_members: false,
collection_id: '<string>',
member_limit: 100
})
};
fetch('http://localhost:6699/api/v1/summaries/collections', 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/summaries/collections",
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>',
'include_members' => false,
'collection_id' => '<string>',
'member_limit' => 100
]),
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/summaries/collections"
payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\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/summaries/collections")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/summaries/collections")
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 \"include_members\": false,\n \"collection_id\": \"<string>\",\n \"member_limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"schema_version": "<string>",
"collections": [
{
"id": "<string>",
"name": "<string>",
"media_count": 123,
"analysis_count": 123,
"description": "<string>",
"updated_at": "<string>",
"members": [
{
"summary_ref": "<string>",
"hash_str": "<string>",
"media_path": "<string>",
"media_basename": "<string>",
"analysis_id": "<string>",
"analysis_name": "<string>"
}
],
"members_truncated": true
}
]
}{
"error": "<string>"
}Authorizations
Jumper Pro license key passed via header
Body
application/json
Filter to one collection. With include_members=true, all compact members are returned.
Legacy bound used only for unfiltered include_members requests; ignored when collection_id is supplied.
Required range:
1 <= x <= 500Last modified on August 25, 2026
Was this page helpful?
⌘I

