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": "<string>",
  "visual_media_paths": [
    "<string>"
  ],
  "transcription_jobs": [
    {
      "path": "<string>",
      "language": "english"
    }
  ],
  "face_clustering_jobs": [
    {
      "cluster_job_name": "<string>",
      "face_media_paths": [
        "<string>"
      ],
      "face_eps": 123,
      "face_min_samples": 123
    }
  ]
}
'
{
  "message": "Analysis started",
  "task_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getjumper.io/llms.txt

Use this file to discover all available pages before exploring further.

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 May 7, 2026