Get transcriptions

Returns a list of transcriptions

get/transcriptions

Request

Base URL
https://api.whereby.dev/v1
Auth
none declared
TypeScript
https://skmtc.dev/whereby/apis/whereby-rest-api/docs/transcriptions/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

roomNamestring

The name of the room

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 transcriptions.

Example response

{
  "results": [
    {
      "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
      "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": "ready",
      "durationInSeconds": 60,
      "type": "LIVE_TRANSCRIPTION",
      "filename": "room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd-2025-01-01T00:00:00.000Z.md",
      "storageType": "WHEREBY_HOSTED"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.