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

# Get sample face images per cluster

> Returns a few sample face thumbnail images for each cluster in a job.
Useful for building a "who is this person?" UI.




## OpenAPI

````yaml /api-reference/openapi-v1.yaml post /faces/clusters/samples
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/samples:
    post:
      tags:
        - Face Clustering
      summary: Get sample face images per cluster
      description: |
        Returns a few sample face thumbnail images for each cluster in a job.
        Useful for building a "who is this person?" UI.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - cache_dir
                - cluster_job_name
              properties:
                cache_dir:
                  type: string
                cluster_job_name:
                  type: string
                limit_per_cluster:
                  type: integer
                  default: 12
                min_cluster_size:
                  type: integer
                  default: 1
                max_cluster_size:
                  type: integer
                  default: 1000000000
                max_clusters:
                  type: integer
                  default: 100
                include_noise:
                  type: boolean
                  default: false
                  description: Include unassigned faces in response
      responses:
        '200':
          description: Cluster samples
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster_job_name:
                    type: string
                  num_clusters:
                    type: integer
                  num_clusters_after_filter:
                    type: integer
                  total_entries:
                    type: integer
                  clusters:
                    type: array
                    items:
                      $ref: '#/components/schemas/ClusterSample'
                  noise_size:
                    type: integer
                    description: Only present if include_noise was true
                  noise_sample:
                    type: array
                    items:
                      type: string
                      format: byte
                    description: Only present if include_noise was true
components:
  schemas:
    ClusterSample:
      type: object
      properties:
        cluster_id:
          type: string
        name:
          type: string
          description: User-assigned name (empty string if unnamed)
        size:
          type: integer
          description: Total faces in this cluster
        sample_faces:
          type: array
          items:
            type: string
            format: byte
          description: Base64-encoded JPEG thumbnails of sample faces
  securitySchemes:
    HeaderAuth:
      type: apiKey
      in: header
      name: X-License-Key
      description: Jumper Pro license key passed via header

````