v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Highlights

Create transcript highlight

Create a highlight on a transcript by specifying start and end timestamps in seconds.

The data entry (referenced by note_id) must contain an audio or video transcript for the highlight to be created. If the entry contains multiple audio/video elements, the first transcript is used.

Tip: to get word-level timestamps for picking start_time and end_time, pair this endpoint with Export data (GET /v1/data/:data_id/export/html). The HTML export wraps each transcript word in a <span> carrying data-monologue-start-time and data-monologue-end-time attributes; the markdown export only includes paragraph-level timestamps. Bounds are snapped to the nearest word, so start_time / end_time returned by Get highlight / List highlights can be sent back here unchanged.

Returns the created highlight.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

post/v1/highlights

Request body

note_idstring required

Unique identifier of the data entry (note) containing the transcript.

start_timenumber required

Start time in seconds within the transcript to begin the highlight.

end_timenumber required

End time in seconds within the transcript to end the highlight.

tag_idsstring[]

Optional list of tag IDs to associate with the highlight.

Example request

{
  "start_time": 10.5,
  "end_time": 25.3
}

Response

201