WIwithchima
Clips

Correct transcript words

Changed on

Correct what a clip's transcript says, one or more words at a time (at most 100 per request). Each edit addresses a word by its transcript index and sets either text (the corrected wording, which also unhides the word) or hidden (whether the word appears in captions and subtitles). Edits change the transcript, captions and subtitles only — never the audio or the clip's timing; use cut-by-transcript to remove spoken words from the video. Visibility and wording are independent: hiding a word preserves any correction made to it. The whole batch is applied atomically as a single transaction, so a request never changes only some of its words. A 500 does not by itself mean nothing changed — the words can land and a later step of the commit still fail — so treat the outcome as either fully applied or not applied at all. Every edit assigns a word outright, so re-sending the identical request is safe and settles it.

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

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Request body

Example request

{
  "words": [
    {
      "breakAfter": true,
      "hidden": true,
      "index": 12,
      "keepWithNext": true,
      "text": "Tella"
    }
  ]
}

Response

OK

Example response

{
  "words": [
    {
      "endTimeMs": 1800,
      "index": 12,
      "startTimeMs": 1500,
      "text": "Hello"
    }
  ]
}

Changes

  • ecfa57e0b3ecRevision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

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

    • info

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

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status