WIwithchima
Clips

Update a clip

Changed on

Update a clip's name, ordering, cuts, background, transition, audio, or frame styling (corner rounding and border style). At least one field must be provided.

patch/v1/videos/{id}/clips/{clipId}

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Request body

animatedCursorboolean

Draw an animated cursor from captured mouse data on this clip's screen recording. Returns 400 when the clip has no screen recording.

borderStyle'none' | 'subtle-shadow' | 'deep-shadow' | 'transparent' | 'solid-shadow-left' | 'solid-shadow-right' | 'snake' | 'glass'

Border and shadow around the clip's frames — the editor Style panel's Border style. solid-shadow-left and solid-shadow-right are the solid shadow and its direction; snake and glass (a liquid glass rim) keep the clip's current settings for that style, else the editor's default. Applies to this clip only, across all of its layouts.

corners'none' | 'regular' | 'squircle'

Corner rounding of the clip's frames (screen and camera) — the editor Style panel's Shape: none (square), regular (rounded) or squircle (very rounded). Applies to this clip only, like the editor's "Apply to this clip only", across all of its layouts. A circle camera stays a circle.

keepCameraFaceCenteredboolean

Pan the camera to keep the presenter's face centered as they move, the editor's Keep face centered; it takes over from cameraFocusPoint while on. Returns 400 when turned on for a clip with no camera or a camera without face detections (made when a recording is processed).

microphoneVolumenumber nullable

Microphone volume for this clip only, overriding the video's microphoneVolume. 1 is the recorded level, 0 mutes it, 2 doubles it. Pass null to clear the override so the clip follows the video again. Null and 0 are no-ops when the clip has no microphone audio. Other values return 400 when the clip has no microphone audio to control, i.e. whenever a read reports the field as absent.

mirrorCameraboolean

Mirror (flip horizontally) this clip's camera, like the editor's Mirror camera. Applies to this clip only. Returns 400 when the clip has no camera.

namestring

New clip name

orderinteger

New position of the clip within the video

studioSoundboolean

Per-clip Studio Sound opt-out. false disables enhanced audio for this clip while the video-level switch (see PATCH /v1/videos/{id} studioSound) stays on; true re-enables it.

systemAudioVolumenumber nullable

System audio (screen or uploaded footage) volume for this clip only, overriding the video's systemAudioVolume. Same range and null-to-clear behaviour as microphoneVolume. Null and 0 are no-ops when the clip has no system audio. Other values return 400 when the clip has no such audio to control, i.e. whenever a read reports the field as absent.

transition'default' | 'smooth' | 'hard_cut'

How a clip enters from the previous one. default inherits the video's defaultClipTransition; smooth and hard_cut override it for this clip. The first clip in a video has nothing to transition from.

Example request

{
  "animatedCursor": true,
  "background": {
    "color": "#000000ff",
    "gradientAngle": 45,
    "gradientColor1": "#ff0080ff",
    "gradientColor2": "#7928caff",
    "shaderGradientPreset": "Halo",
    "sourceId": "su_abc123",
    "type": "solid",
    "videoDurationSeconds": 12.4
  },
  "borderStyle": "subtle-shadow",
  "cameraFocusPoint": {
    "xPct": 50,
    "yPct": 35
  },
  "corners": "squircle",
  "cuts": [
    {
      "durationMs": 750,
      "startTimeMs": 1500
    }
  ],
  "keepCameraFaceCentered": true,
  "microphoneVolume": 0.4,
  "mirrorCamera": true,
  "name": "Updated intro",
  "order": 2,
  "systemAudioVolume": 1.5,
  "transition": "default"
}

Response

OK

Example response

{
  "clip": {
    "animatedCursor": true,
    "background": {
      "color": "#000000ff",
      "gradientAngle": 45,
      "gradientColor1": "#ff0080ff",
      "gradientColor2": "#7928caff",
      "shaderGradientPreset": "Halo",
      "sourceId": "su_abc123",
      "type": "solid",
      "videoDurationSeconds": 12.4
    },
    "borderStyle": "subtle-shadow",
    "cameraFocusPoint": {
      "xPct": 50,
      "yPct": 35
    },
    "corners": "regular",
    "createdAt": "2026-01-15T10:30:00.000Z",
    "cuts": [
      {
        "durationMs": 750,
        "startTimeMs": 1500
      }
    ],
    "durationSeconds": 12.5,
    "id": "cl_xyz789ghi012",
    "layoutSceneType": "combi",
    "maxDurationSeconds": 14.2,
    "microphoneVolume": 0.4,
    "name": "Intro",
    "transition": "default",
    "updatedAt": "2026-01-15T14:45:00.000Z",
    "videoId": "vid_abc123def456"
  }
}

Changes

  • 5caf72ed8935Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 12b6eccbb321Revision changes
    • warning

      added the new ambient enum value to the // response property for the response status

    • info

      added the new optional request property /////

    • info

      added the new ambient enum value to the request property /////

    • info

      added the optional property // to the response with the status