Transcription

The transcription.realtime resource runs live transcription on a room's active session, with an optional post-session summary. (To transcribe a recording after it has completed, set transcription on the recording. See Recordings.)

Start transcription

Node.js

const t = await client.transcription.realtime.start(roomId, {
  language: "en-US",
  summary: { enabled: true, prompt: "Summarize decisions and action items." },
});

Go

t, err := client.Transcription.Realtime.Start(ctx, roomID, videosdk.StartRealtimeTranscriptionParams{
	Language: "en-US",
	Summary:  &videosdk.RealtimeSummaryConfig{Enabled: videosdk.Bool(true), Prompt: videosdk.String("Summarize decisions and action items.")},
})

Rust

let t = client.transcription().realtime().start(room_id, StartRealtimeTranscriptionParams {
    language: Some("en-US".into()),
    summary: Some(RealtimeSummaryConfig {
        enabled: Some(true),
        prompt: Some("Summarize decisions and action items.".into()),
    }),
    ..Default::default()
}).await?;

Options: language, modelId, webhookUrl, summary.

Stop transcription

The transcription is identified by its room id.

Node.js

await client.transcription.realtime.stop(roomId);

Go

client.Transcription.Realtime.Stop(ctx, roomID)

Rust

client.transcription().realtime().stop(room_id).await?;

Get and list

Node.js

await client.transcription.realtime.get(transcriptionId);
await client.transcription.realtime.list();

Go

client.Transcription.Realtime.Get(ctx, transcriptionID)
client.Transcription.Realtime.List(ctx, videosdk.ListRealtimeTranscriptionsParams{})

Rust

client.transcription().realtime().get(transcription_id).await?;
client.transcription().realtime().list(ListRealtimeTranscriptionsParams::default()).await?;

list supports a status filter and pagination only, not room id.

The transcription object

Returned by transcription.realtime.start and get, and as the items of a transcription.realtime.list page.

Field	Type	Description
id	string	Transcription id.
roomId	string	Room the transcription runs in.
status	string	Transcription status.
transcriptionFilePaths	object	Output file URLs keyed by format (e.g. txt).
summarizedFilePaths	object	Summary file URLs keyed by format (e.g. txt).
start	string	Start time (ISO-8601).
end	string	End time, null while running.