Skip to main content
POST
/
analyze
Start media analysis
curl --request POST \
  --url http://localhost:6699/api/v1/analyze \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "/Users/me/JumperAnalysis",
  "visual_media_paths": [
    "/Videos/interview.mp4",
    "/Videos/photo.jpg"
  ],
  "transcription_jobs": [
    {
      "path": "/Videos/interview.mp4",
      "language": "english"
    },
    {
      "path": "/Audio/voiceover.mp3",
      "language": "english"
    }
  ]
}
'
{
  "message": "Analysis started",
  "task_id": "<string>"
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Body

application/json
cache_dir
string
required

Where to store analysis results

visual_media_paths
string[]

Files to run visual analysis on

transcription_jobs
object[]

Files to transcribe, with optional language hints

face_clustering_jobs
object[]

Face detection and clustering job definitions

Response

Analysis started

message
string
Example:

"Analysis started"

task_id
string

Use this ID to join a SocketIO room for progress events

Last modified on February 18, 2026