---
title: "Read a shared media page"
method: GET
path: "/embed/insight"
tags: ["Shared Links"]
---

# Read a shared media page

`GET /embed/insight`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/embed/insight`
- Auth: none required

Read the media page a share link opens: the media, its transcript and insights. For a dashboard link it also carries `annotationSettings`, and the media must be in one of the dashboard's folders. `mediaData.transcriptRevision` is read with the transcript: place labels and comments only while it matches the `transcriptRevision` from the labels and comments routes, and read again otherwise. This response is never cached. No API key or access token: the `token` is the only credential.

## Query parameters

- `token` string, required
- `mediaId` string

## Response `200`

Success

- object
  - `status` 'success': `success` on every 2xx response.
  - `data` object: The media page. Only the keys relevant to labels, comments and the thumbnail are listed here.
    - `mediaData` object
      - `transcriptRevision` integer: Revision of the transcript in this response. 0 for media saved before revisions existed.
      - `thumbnailUrl` string: A signed link to the video's thumbnail, custom or automatic. Present only when the file has one. It expires, so do not store it.
    - `annotationSettings` object: What the link allows for labels and comments, resolved from the dashboard's settings. Present for dashboard links only.
      - `labels` object
        - `isEnabled` boolean: Whether labels are on.
        - `mode` 'view' | 'apply': `view` or `apply`.
        - `groups` object[]: The allowed label groups. Empty while labels are off.
          - `labelId` string
          - `name` string
        - `labels` object[]: Active labels of the allowed groups. Empty while labels are off.
          - `labelId` string: Id of the label.
          - `name` string: Name of the label.
          - `color` string: Hex colour, such as `#6366f1`.
          - `description` string: Description of the label.
          - `parentId` unknown
      - `comments` object
        - `isEnabled` boolean: Whether comments are on.
        - `mode` 'view' | 'reply': `view` or `reply`.
      - `reviewers` string[]: Names a viewer may write as, sent as `reviewerName`: the dashboard's feedback submitter names. Empty unless `apply` or `reply` mode is on.
      - `allowOtherReviewer` boolean: A viewer may also type a name that is not listed. True when the dashboard's `feedback.allowOtherSubmitter` is on and `apply` or `reply` mode is on.

## Other responses

- `403`: The media is not in the dashboard's folders
- `404`: Unknown token or no active subscription

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)