List watch folders
curl --request GET \
--url http://localhost:6699/api/v1/watch-folders \
--header 'X-License-Key: <api-key>'import requests
url = "http://localhost:6699/api/v1/watch-folders"
headers = {"X-License-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-License-Key': '<api-key>'}};
fetch('http://localhost:6699/api/v1/watch-folders', 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/watch-folders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:6699/api/v1/watch-folders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-License-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:6699/api/v1/watch-folders")
.header("X-License-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/watch-folders")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-License-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"watch_folders": [
{
"id": "<string>",
"folder_path": "<string>",
"enabled": true,
"enable_visual_analysis": true,
"enable_audio_analysis": true,
"enable_face_analysis": true,
"audio_language": "<string>",
"cluster_job_name": "<string>",
"face_eps": 123,
"face_min_samples": 123,
"cache_dir": "<string>",
"excluded_extensions": [
"<string>"
],
"excluded_filename_globs": [
"<string>"
],
"excluded_folder_globs": [
"<string>"
],
"created_at": 123,
"last_poll_time": 123,
"files_analyzed_count": 123
}
],
"service_status": {
"current_folder": "<string>",
"current_file": "<string>",
"files_pending": 123,
"files_processed_this_session": 123,
"last_error": "<string>",
"paused_until": 123,
"folder_stats": {}
}
}Watch Folders
List watch folders
Returns all configured watch folders and the background service status.
GET
/
watch-folders
List watch folders
curl --request GET \
--url http://localhost:6699/api/v1/watch-folders \
--header 'X-License-Key: <api-key>'import requests
url = "http://localhost:6699/api/v1/watch-folders"
headers = {"X-License-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-License-Key': '<api-key>'}};
fetch('http://localhost:6699/api/v1/watch-folders', 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/watch-folders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:6699/api/v1/watch-folders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-License-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:6699/api/v1/watch-folders")
.header("X-License-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:6699/api/v1/watch-folders")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-License-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"watch_folders": [
{
"id": "<string>",
"folder_path": "<string>",
"enabled": true,
"enable_visual_analysis": true,
"enable_audio_analysis": true,
"enable_face_analysis": true,
"audio_language": "<string>",
"cluster_job_name": "<string>",
"face_eps": 123,
"face_min_samples": 123,
"cache_dir": "<string>",
"excluded_extensions": [
"<string>"
],
"excluded_filename_globs": [
"<string>"
],
"excluded_folder_globs": [
"<string>"
],
"created_at": 123,
"last_poll_time": 123,
"files_analyzed_count": 123
}
],
"service_status": {
"current_folder": "<string>",
"current_file": "<string>",
"files_pending": 123,
"files_processed_this_session": 123,
"last_error": "<string>",
"paused_until": 123,
"folder_stats": {}
}
}Last modified on July 1, 2026
Was this page helpful?
⌘I

