Shared Links

Change a passage's labels through a share link

Replace the labels on your own passage through a dashboard share link. Allowed while labels are on with labels.mode set to apply. Every label must be one the dashboard offers, or the request returns 400 "Choose labels this dashboard offers." Moving a passage and reviewing re-anchored passages stay in the app. 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.

patch/embed/media/{mediaId}/labels/{mediaLabelId}

Request

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

mediaLabelIdstring required

Id of the labelled passage, from mediaLabelId. 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.

labelIdsstring[] required

Labels to put on the passage. 1 to 20 ids, no repeats. Each must be an active label (not a group) in your company, or the request returns 400 "Choose active labels from this workspace (groups cannot be applied)."

Response

Success

status'success'

success on every 2xx response.

Changes

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