Skip to main content

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 the fact, set transcription on the recording; see Recordings.)

Start transcription

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

Options: language, modelId, webhookUrl, summary.

Stop transcription

Keyed by room id.

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

Get and list

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

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

The transcription object

id, roomId, status, start, end, and the output URLs transcriptionFilePaths and summarizedFilePaths.

Got a Question? Ask us on discord