> ## 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 hierarchical summary collections

> Returns compact collection metadata and counts without enumerating
members by default. Pass collection_id with include_members=true to
return every compact registry member of only that collection, without
loading summary text or applying the legacy 500-member cap.




## OpenAPI

````yaml /api-reference/openapi-v1.yaml post /summaries/collections
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, face detection with clustering, and hierarchical
    summaries.

    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:
  /summaries/collections:
    post:
      tags:
        - Summaries
      summary: List hierarchical summary collections
      description: |
        Returns compact collection metadata and counts without enumerating
        members by default. Pass collection_id with include_members=true to
        return every compact registry member of only that collection, without
        loading summary text or applying the legacy 500-member cap.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - cache_dir
              properties:
                cache_dir:
                  type: string
                include_members:
                  type: boolean
                  default: false
                collection_id:
                  type: string
                  description: >-
                    Filter to one collection. With include_members=true, all
                    compact members are returned.
                member_limit:
                  type: integer
                  default: 100
                  minimum: 1
                  maximum: 500
                  description: >-
                    Legacy bound used only for unfiltered include_members
                    requests; ignored when collection_id is supplied.
      responses:
        '200':
          description: Compact collection listing
          content:
            application/json:
              schema:
                type: object
                required:
                  - schema_version
                  - collections
                properties:
                  schema_version:
                    type: string
                  collections:
                    type: array
                    items:
                      $ref: '#/components/schemas/SummaryCollection'
        '400':
          description: Invalid cache directory, collection selector, or member options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SummaryCollection:
      type: object
      required:
        - id
        - name
        - media_count
        - analysis_count
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        media_count:
          type: integer
        analysis_count:
          type: integer
        updated_at:
          type: string
          nullable: true
        members:
          type: array
          description: Present only when include_members is true.
          items:
            $ref: '#/components/schemas/SummaryCollectionMember'
        members_truncated:
          type: boolean
          description: Always false for a collection_id-filtered expansion.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
        - error
    SummaryCollectionMember:
      type: object
      required:
        - summary_ref
        - hash_str
        - media_path
        - media_basename
        - analysis_id
        - analysis_name
      properties:
        summary_ref:
          type: string
          description: >-
            Stable `<media_hash>:<analysis_id>` reference for later summary
            reads.
        hash_str:
          type: string
        media_path:
          type: string
        media_basename:
          type: string
        analysis_id:
          type: string
        analysis_name:
          type: string
  securitySchemes:
    HeaderAuth:
      type: apiKey
      in: header
      name: X-License-Key
      description: Jumper Pro license key passed via header

````