Media Embed

Get Embed Session

Changed on

Read one viewing session in full: the same fields as the session list, plus each media file opened, each question asked to the AI chat, and a page of the session's events in time order. Use eventsPage and eventsPageSize to walk through long sessions.

Returns 404 when the session does not belong to this embed. Members without access to all folders only see embeds for media and folders they can open. Any other embed, or an embed that is deleted or in another workspace, returns 404.

get/embed/sessions/{embedId}/detail/{id}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/sessions/{embedId}/detail/{id}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

embedIdstring required

The _id of the embed, as returned when you create or check an embed. Must be a 24 character hex id.

idstring required

The session's _id, as returned by the session list. Must be a 24 character hex id.

Query parameters

eventsPageinteger

Page of events to return, starting at 0. Optional. Defaults to 0.

eventsPageSizeinteger

Events per page, from 1 to 500. Optional. Defaults to 200.

Response

OK

status'success'

Changes