Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get transcription

Returns the specified transcription metadata.

get/transcriptions/{transcriptionId}

Path parameters

transcriptionIdstring required

Transcription ID.

Response

A JSON object representing the transcription.

transcriptionIdstring required

The ID of the transcription.

roomSessionIdstring required

The ID of the room session.

filenamestring

The filename of the transcription that was written to either Whereby or self hosted storage buckets (see: storageType).

roomNamestring required

The name of the room.

startDatestring date-time required

When the transcription starts. Always in UTC, regardless of the input timezone.

endDatestring date-time required

When the transcription ends. Always in UTC, regardless of the input timezone.

state'ready' | 'failed' | 'in_progress' required

The state of the transcription

  • ready - The transcription is ready to be downloaded
  • failed - The transcription failed to be generated
  • in_progress - The transcription is still being generated
createdAtstring date-time required

When the transcription was created. Always in UTC, regardless of the input timezone.

durationInSecondsnumber

The total billable time in seconds for this transcription.

type'LIVE_TRANSCRIPTION' | 'RECORDING_TRANSCRIPTION' required

The type of the transcription

  • LIVE_TRANSCRIPTION - Session Transcription
  • RECORDING_TRANSCRIPTION - generated based on a recording
storageType'WHEREBY_HOSTED' | 'SELF_HOSTED'

The storage type of the transcription

  • WHEREBY_HOSTED - files kept with Whereby
  • SELF_HOSTED - files stored in external location

Example response

{
  "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"
}