> ## 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.

# List face clustering jobs

> Returns all clustering jobs and summary statistics for each.



## OpenAPI

````yaml /api-reference/openapi-v1.yaml get /faces/clusters
openapi: 3.0.3
info:
  title: Jumper Public API
  version: '1.0'
  description: >
    REST API for third-party integrations with Jumper's media analysis engine.


    Jumper analyzes video, image, and audio files — enabling semantic visual
    search,

    speech transcription, and face detection with clustering.

    This API exposes those capabilities for use by MAM systems, automation
    pipelines,

    and custom tooling.


    ## Authentication


    All endpoints except `/health` require a **Jumper Pro** license key.

    The OpenAPI contract models the supported `X-License-Key` header flow.


    Jumper also accepts a `license_key` field in many JSON POST bodies as a

    convenience, but that is a Jumper-specific request-body convention rather

    than an OpenAPI security scheme.


    Invalid or missing keys return `401`. Non-Pro keys return `403`.


    ## Key Concepts


    - **`cache_dir`** — The folder where Jumper stores analysis data (visual
    analysis, transcriptions, face clusters). You choose this path.

    - **`media_paths`** — Absolute filesystem paths to media files. Jumper needs
    direct access to these files.

    - **`hash_str`** — A CRC32-based hash that uniquely identifies a media file.
    Returned by the metadata endpoint.

    - **`model_key`** — Internal identifier for a visual or speech analysis
    model variant (e.g. `v2-medium-256`).
  contact:
    name: Jumper
    url: https://getjumper.io
servers:
  - url: http://localhost:6699/api/v1
    description: Local Jumper backend
security:
  - HeaderAuth: []
paths:
  /faces/clusters:
    get:
      tags:
        - Face Clustering
      summary: List face clustering jobs
      description: Returns all clustering jobs and summary statistics for each.
      parameters:
        - name: cache_dir
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Cluster job list
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster_jobs:
                    type: array
                    items:
                      type: string
                    description: Job names
                  jobs:
                    type: array
                    items:
                      $ref: '#/components/schemas/ClusterJob'
components:
  schemas:
    ClusterJob:
      type: object
      properties:
        name:
          type: string
          description: Name of the clustering job
        total_entries:
          type: integer
          description: Total detected faces
        num_clusters:
          type: integer
          description: Number of clusters found
        noise_entries:
          type: integer
          description: Faces not assigned to any cluster
        cluster_ids:
          type: array
          items:
            type: string
          description: List of cluster IDs
        face_storage_version:
          type: integer
          description: On-disk face storage format version. Legacy jobs may not be mutable.
        media_hashes:
          type: array
          items:
            type: string
          description: Hashes of media files included in this job
  securitySchemes:
    HeaderAuth:
      type: apiKey
      in: header
      name: X-License-Key
      description: Jumper Pro license key passed via header

````