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

# Update a watch folder

> Modify settings for an existing watch folder. Only include fields you want to change.
Filename exclusion glob patterns are matched against the filename only, not the full path.
Folder exclusion glob patterns without slashes match folder names; patterns with slashes match relative folder paths segment by segment.




## OpenAPI

````yaml /api-reference/openapi-v1.yaml put /watch-folders/{watch_folder_id}
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:
  /watch-folders/{watch_folder_id}:
    put:
      tags:
        - Watch Folders
      summary: Update a watch folder
      description: >
        Modify settings for an existing watch folder. Only include fields you
        want to change.

        Filename exclusion glob patterns are matched against the filename only,
        not the full path.

        Folder exclusion glob patterns without slashes match folder names;
        patterns with slashes match relative folder paths segment by segment.
      parameters:
        - name: watch_folder_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                enable_visual_analysis:
                  type: boolean
                enable_audio_analysis:
                  type: boolean
                enable_face_analysis:
                  type: boolean
                audio_language:
                  type: string
                cluster_job_name:
                  type: string
                face_eps:
                  type: number
                face_min_samples:
                  type: integer
                cache_dir:
                  type: string
                excluded_extensions:
                  type: array
                  items:
                    type: string
                excluded_filename_globs:
                  type: array
                  items:
                    type: string
                excluded_folder_globs:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Watch folder updated
        '404':
          description: Watch folder not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
        - error
  securitySchemes:
    HeaderAuth:
      type: apiKey
      in: header
      name: X-License-Key
      description: Jumper Pro license key passed via header

````