Shared Links

List labels through a share link

Read the labelled passages of a media file through a dashboard share link. Allowed while the dashboard's labels.isEnabled is true. Only the labels the dashboard shows are returned (its label groups, or every active label when it lists none). 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. A media or folder embed token also works here while the embed's meta.isLabels is true, for the embed's own media or media in its folders; an embed shows every active label and can never write. Reads are limited to 120 requests a minute per IP address.

get/embed/media/{mediaId}/labels

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/media/{mediaId}/labels
  • 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.

Response

Success

status'success'

success on every 2xx response.

Changes

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