WIwithchima
Clips

Get clip transcript

Changed on

Returns the words spoken in a clip with cuts applied — what viewers actually hear. Times are in ms relative to the clip's playback start. Word indices are stable identifiers for cut-by-transcript; they don't shift when cuts change. Pass startTimeMs/endTimeMs to read a long clip in windows; a word belongs to the window its start time falls in. Pass view=text for every word with its index as plain text, one sentence per line, about a seventh of the size: read a whole long clip that way (to find retakes, repeats or where something is said), then the words view for a stretch where you need exact times. view=sentences gives one row per sentence instead. Pass includeCut=true to also get the words cuts removed, with their times in the source recording. Answers 503 while a clip that was just recorded is still being transcribed; retry after about 30 seconds.

get/v1/videos/{id}/clips/{clipId}/transcript

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Query parameters

startTimeMsinteger

Only return items at or after this time, in ms on the clip's playback timeline. Defaults to the clip's start.

Example:60000
endTimeMsinteger

Only return items before this time (exclusive), in ms on the clip's playback timeline. Must be greater than startTimeMs. Defaults to the clip's end. Page through a long clip with windows that meet end to start.

Example:120000
view'words' | 'sentences' | 'text'

words (default): every word with its index, times and flags. text: every word with its index as plain text, one sentence per line starting with its start time, about a seventh of the size, for reading a whole long clip (finding retakes, repeats or where something is said). sentences: one row per sentence (first and last word index, start and end time, text), about a quarter of the size. A time window cuts sentences at its edges.

Example:text
includeCut'true' | 'false'

true: also return the words that cuts removed, each marked cut, with every word's times in the clip's source recording (sourceStartTimeMs/sourceEndTimeMs). Use it to find footage the cuts took out, such as a retake, without undoing the cuts. Kept words still carry their playback startTimeMs/endTimeMs. startTimeMs/endTimeMs filter on the source times. Words view only.

Example:true

Response

OK

OR
OR
OR

Example response

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

Changes

  • d74197bff4c4Revision changes
    • info

      added the new enum value text to the query request parameter view

    • info

      added to the response body anyOf list for the response status

  • 75d4207a51cbRevision changes
    • info

      added the new optional query request parameter includeCut

    • info

      added to the response body anyOf list for the response status