Sign in
Clips

Update a clip

Update a clip's name, ordering, cuts, background, or transition. At least one field must be provided.

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

Path parameters

idstring required

Video identifier

Example:vid_abc123def456

Video identifier

clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Clip identifier

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.

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. Returns 400 when the clip has no microphone audio to control, i.e. whenever a read reports the field as absent.

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. Returns 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",
    "sourceId": "su_abc123",
    "type": "solid",
    "videoDurationSeconds": 12.4
  },
  "cuts": [
    {
      "durationMs": 750,
      "startTimeMs": 1500
    }
  ],
  "microphoneVolume": 0.4,
  "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",
      "sourceId": "su_abc123",
      "type": "solid",
      "videoDurationSeconds": 12.4
    },
    "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

No recorded changes to this endpoint across all 1 revision of this API.