Shared Links

Comment through a share link

Start a thread or reply through a dashboard share link. Allowed while comments are on with comments.mode set to reply. Send range with expectedTranscriptRevision to comment on a passage, parentId to reply, or neither to comment on the whole file. mediaLabelId is not accepted here. No API key or access token: the share link token is the only credential. The media must be in one of the dashboard's folders. Every refusal returns the same 404 {"message": "Not found."}, so a link holder cannot tell which check failed. The entry is recorded under reviewerName via this dashboard. The name is chosen by the link holder and not authenticated, the same as feedback; only a name the dashboard allows is accepted. A name can change or delete only the entries written under it from the same dashboard. Writes are limited to 30 requests a minute per IP address.

post/embed/media/{mediaId}/comments

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/media/{mediaId}/comments
  • Auth: none required

Path parameters

mediaIdstring required

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

tokenstring required

The share link token of a dashboard, or of a media or folder embed on the read routes. Up to 200 characters.

Request body

reviewerNamestring required

The name you write as: one of annotationSettings.reviewers, or any name when allowOtherReviewer is true. Chosen by the link holder and not authenticated. Trimmed; a listed name in another case is stored with the listed spelling. Required.

bodystring required

Comment text. Trimmed, then 1 to 5,000 characters.

expectedTranscriptRevisioninteger

Required when you send range, not allowed without it. The transcriptRevision you read the transcript at. Integer, 0 or more. A stale value returns 409.

parentIdstring

commentId of the thread's first comment, to post a reply. 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.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.