WIwithchima
Clips

Auto-generate zooms from mouse activity

Changed on

Generates tracking zooms from the mouse clicks in the clip's screen recording — the API twin of the editor's "Generate zooms". Every click opens a zoom window; nearby windows are merged. Requires the clip to contain a screen recording; returns an empty list when it has no usable mouse clicks.

post/v1/videos/{id}/clips/{clipId}/zooms/auto

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Request body

intensity'gentle' | 'subtle' | 'moderate' | 'focused' | 'intense' | 'slow' | 'medium' | 'fast'

The editor's zoom preset: gentle (1.5x, the calmest, easing in softly), subtle (1.5x, slow and smooth), moderate (default, 2x), focused (2x, settles fast) or intense (2.5x, snappy). It also sets the clip's zoom animation style. slow, medium and fast mean subtle, moderate and intense.

replaceExistingboolean

Defaults to true: the clip's existing tracking zooms are REMOVED before the generated ones are added, so repeated calls regenerate instead of stacking. Pass false to keep existing tracking zooms. Manual zooms are never touched.

scalenumber

Override the magnification factor (1 = no zoom, 3.5 = max). Defaults to the preset's scale (1.5 for gentle and subtle, 2 for moderate and focused, 2.5 for intense).

Example request

{
  "intensity": "moderate",
  "replaceExisting": true,
  "scale": 1.5
}

Response

OK

Example response

{
  "zooms": [
    {
      "durationMs": 2000,
      "focusPoint": {
        "xPct": 50,
        "yPct": 50
      },
      "id": "ef_abc123",
      "introTransition": "smooth",
      "outroTransition": "smooth",
      "scale": 2,
      "startTimeMs": 1000,
      "type": "manualZoom"
    }
  ]
}

Changes

  • 0cc3fcd307adRevision changes
    • info

      added the new gentle enum value to the request property

  • 063dd2193962Revision changes
    • info

      added the new focused enum value to the request property

    • info

      added the new intense enum value to the request property

    • info

      added the new moderate enum value to the request property

    • info

      added the new subtle enum value to the request property