List comment threads
Returns the media's comment threads, oldest first, with the media's current transcriptRevision. Each thread is its first comment with a replies array. Anyone who can open the file can read its comments; no comments permission is needed. The media must belong to your company and be one you can open. Owners and members with the folder Access all permission can open any file; everyone else can open files in folders assigned to them or their groups, and files they own. Any other media returns 404, the same as a media id that does not exist.
A deleted first comment that still has replies stays in the list with an empty body and isDeleted: true, so the replies keep their context. Deleted replies are left out.
When a transcript is saved, labels and comments on passages are moved to the new text in the background, after the save has answered. Until that finishes, which is normally a moment, a list can return anchors whose anchor.transcriptRevision is lower than the top-level transcriptRevision. Fetch the list again shortly after a save.
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/media/{mediaId}/comments
- Auth: API key in header x-speakai-key and API key in header x-access-token
Path parameters
Id of the media file. Trimmed, then 1 to 64 characters from A-Z, a-z, 0-9, _ and - (pattern ^[A-Za-z0-9_-]{1,64}$). Anything else returns 400.
Query parameters
all (the default), open or resolved threads, or file for comments on the whole file only. One of: all, open, resolved, file.
Response
Success
Changes
No recorded changes to this operation across all 2 revisions of this API.