latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get summaries

Returns a list of summaries

Session summaries are currently in Beta and available to selected customers only. Email us at embedded@whereby.com to join our pilot program (terms and conditions apply).

get/summaries

Query parameters

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example:8f4031bfc7640c5f267b11b6fe0c2507

limitinteger

The limit for the pagination - the maximum number of results that will be returned within a single API response.

Sort results by a field. Accepted fields are: roomName, startDate and durationInSeconds. Accepted sort values are 'asc' and 'desc'.

Response

A JSON array representing the summaries.

resultsSummary[] required

Example response

{
  "results": [
    {
      "summaryId": "c429ff78-9f03-49de-b427-546bcd848050",
      "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
      "summary": {
        "summary": "This is a meeting summary"
      },
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-01T00:01:00.000Z",
      "state": "completed",
      "modifiedAt": "2025-01-01T00:00:00.000Z",
      "template": "General Narrative"
    }
  ]
}