Developers
API Reference

Create transcript highlight

post
https://dovetail.com/api/v1/highlights

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

The note must contain an audio or video transcript for the highlight to be created. If the note contains multiple audio/video elements, the first transcript is used.

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.

Body Params

Body

string
required

Unique identifier of the note containing the transcript.

number
required
≥ 0

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

number
required
≥ 0

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

tag_ids
array of strings

Optional list of tag IDs to associate with the highlight.

tag_ids
Responses

Updated 18 days ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 18 days ago