Skip to main content
POST
/
watch-folders
Create a watch folder
curl --request POST \
  --url http://localhost:6699/api/v1/watch-folders \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "folder_path": "<string>",
  "cache_dir": "<string>",
  "enabled": true,
  "enable_visual_analysis": true,
  "enable_audio_analysis": false,
  "enable_face_analysis": false,
  "audio_language": "english",
  "cluster_job_name": "<string>",
  "face_eps": 0.48,
  "face_min_samples": 5
}
'
{
  "message": "<string>",
  "watch_folder": {
    "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>",
    "created_at": 123
  }
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Body

application/json
folder_path
string
required

Absolute path to the folder to watch

cache_dir
string

Where to store analysis results (optional, uses default if omitted)

enabled
boolean
default:true
enable_visual_analysis
boolean
default:true
enable_audio_analysis
boolean
default:false
enable_face_analysis
boolean
default:false
audio_language
string
default:english
cluster_job_name
string

Required when face analysis is enabled

face_eps
number
default:0.48
face_min_samples
integer
default:5

Response

Watch folder created

message
string
watch_folder
object
Last modified on February 18, 2026