Sign in

v2

latestOpenAPI 3.0.32026-07-266076394.0 KB
transcript

transcript/:transcriptId

Get info about a Transcript

get/transcript/{transcriptId}

Path parameters

transcriptIdstring required

Response

200

transcriptIdstring

A unique, opaque ID for this object. You can use this ID in API calls, and in paginated list operations.

domainIdstring

The Id of the domain.

roomIdstring

The id of the room.

mtgSessionIdstring

The meeting session ID for this transcription.

status't_finished' | 't_in_progress' | 't_error' | 't_deleted'
isVttAvailableboolean

Whether the transcription has been stored in a WebVTT file. See transcription storage.

durationinteger

How many seconds long the transcription is, approximately.

errorstring

If status is t_error, this provide the description of the error, otherwise null.

created_atstring date-time

When the transcript record was created (i.e. transcription started).

updated_atstring date-time

When the transcript record was last updated.

Example response

{
  "transcriptId": "0cb313e1-211f-4be0-833d-8c7305b19902",
  "roomId": "1a5afbf4-211f-4be0-833d-8c7305b19902",
  "mtgSessionId": "257764e6-c74e-4c30-944a-a887a03173a3",
  "status": "t_finished",
  "isVttAvailable": true,
  "duration": 277,
  "outParams": {
    "s3key": "mydomain/test-recording-room/11245260397",
    "bucket": "my-transcript-bucket",
    "region": "us-west-2"
  },
  "error": "Failed to upload Vtt",
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:35:00.000Z"
}