WIwithchima
Clips

List key presses on a clip

Changed on

Returns the keys pressed during the clip's screen recording, mapped onto the clip's playback timeline (cuts applied): each key going down or up with the modifiers held (such as command+C), and each change in held modifiers. Keys typed into Tella's own window are left out, and only the key's label is returned, never the typed characters. Key presses can reveal what was typed, so only the video's creator and editors can read them. Only Mac app recordings capture the keyboard; other clips return an empty list. Pass startTimeMs/endTimeMs to read a window.

get/v1/videos/{id}/clips/{clipId}/key-events

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

Response

OK

Example response

{
  "events": [
    {
      "key": "C",
      "modifiers": [
        "command"
      ],
      "timestampMs": 1250
    }
  ]
}

Changes