deepgram-js-conversational-stt
Use when writing or reviewing JavaScript/TypeScript in this repo that calls Deepgram Conversational STT v2 / Flux (`/v2/listen`) for turn-aware streaming transcription. Covers `client.listen.v2.createConnection()` / `connect()`, Flux models, and turn events like `TurnInfo`. Use `deepgram-js-speech-to-text` for standard v1 ASR and `deepgram-js-voice-agent` for full-duplex assistants. Triggers include "flux", "v2 listen", "conversational STT", "turn detection", "end of turn", "EOT", and "listen.v2".
How do I install this agent skill?
npx skills add https://github.com/deepgram/deepgram-js-sdk --skill deepgram-js-conversational-sttIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides instructions for using Deepgram's Conversational STT JavaScript SDK. It uses standard practices for secret management and references official vendor resources. While the skill processes external audio which theoretically presents an indirect prompt injection surface, this is inherent to its primary purpose and handled safely within the documented context.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Using Deepgram Conversational STT / Flux (JavaScript / TypeScript SDK)
Turn-aware streaming STT via /v2/listen for conversational audio and explicit turn events.
When to use this product
- You need turn-aware transcription, not just a word stream.
- You want Flux-style events like
TurnInfoandConnected. - You are building a conversational interface but do not want the full Voice Agent runtime.
Use a different skill when:
- You want general v1 transcription or prerecorded REST →
deepgram-js-speech-to-text. - You want a hosted assistant with think + speak built in →
deepgram-js-voice-agent. - You want analytics overlays like sentiment and summaries →
deepgram-js-audio-intelligence.
Authentication
require("dotenv").config();
const { DeepgramClient } = require("@deepgram/sdk");
const deepgramClient = new DeepgramClient({
apiKey: process.env.DEEPGRAM_API_KEY,
});
Quick start
From examples/26-transcription-live-websocket-v2.ts:
const deepgramConnection = await deepgramClient.listen.v2.createConnection({
model: "flux-general-en",
});
deepgramConnection.on("message", (data) => {
if (data.type === "Connected") {
console.log("Connected:", data);
} else if (data.type === "TurnInfo") {
console.log("Turn Info:", data);
} else if (data.type === "FatalError") {
deepgramConnection.close();
}
});
deepgramConnection.connect();
await deepgramConnection.waitForOpen();
// Swap this for a live mic capture in real apps; the repo example uses
// `createReadStream` over a sample file.
const { createReadStream } = require("node:fs");
const audioStream = createReadStream("samples/spacewalk.wav");
audioStream.on("data", (chunk) => {
deepgramConnection.sendMedia(chunk);
});
audioStream.on("end", () => {
deepgramConnection.sendCloseStream({ type: "CloseStream" });
});
Key parameters / API surface
- Connect args from
src/api/resources/listen/resources/v2/client/Client.ts:model,encoding,sample_rate,eager_eot_threshold,eot_threshold,eot_timeout_ms,keyterm,tag,mip_opt_out. - Socket methods from
src/api/resources/listen/resources/v2/client/Socket.ts:sendMedia(...),sendCloseStream(...),sendListenV2Configure(...),waitForOpen(). - Custom wrapper additions from
src/CustomClient.ts:createConnection(...)alias and Node-onlyping(...)helper.
Limitations
- The current generated
ListenV2Modeltype only exposes"flux-general-en". - Product docs mention broader Flux capabilities, but
flux-general-multi/language_hintare not surfaced in this repo's generated types today.
API reference (layered)
- In-repo reference:
reference.mddoes not currently documentlisten.v2; usesrc/CustomClient.tsandsrc/api/resources/listen/resources/v2/client/{Client,Socket}.tsas the in-repo source of truth. - Canonical OpenAPI (REST): https://developers.deepgram.com/openapi.yaml
- Canonical AsyncAPI (WSS): https://developers.deepgram.com/asyncapi.yaml
- Context7: library ID
/llmstxt/developers_deepgram_llms_txt - Product docs:
Gotchas
- There is no REST path here. This skill is
/v2/listenWebSocket only. - Current repo typing only allows
flux-general-en. Treat multilingual Flux support as a product capability not yet reflected in this SDK surface. - Close with
sendCloseStream, notsendFinalize. Finalize is the v1 pattern. ping()is Node-only.src/CustomClient.tsthrows in browsers because browser WS ping frames are not user-exposed.createConnection()is lazy. Callconnect()after registering handlers.- The example explicitly warns about access/availability. A 400 may mean your account or endpoint is not enabled yet, not that your socket code is wrong.
- Omit
encodingfor containerized audio. Keep it for raw PCM/Opus streams.
Example files in this repo
examples/26-transcription-live-websocket-v2.tsexamples/27-deepgram-session-header.ts
Central product skills
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
npx skills add deepgram/skills
This SDK ships language-idiomatic code skills; deepgram/skills ships cross-language product knowledge (see api, docs, recipes, examples, starters, setup-mcp).
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/deepgram/deepgram-js-sdk/deepgram-js-conversational-stt">View deepgram-js-conversational-stt on skillZs</a>