Practical overview
When it fits
Use it when application code needs a JavaScript/TypeScript client for Deepgram APIs, particularly for streaming speech workflows.
Who it is for
- JavaScript and TypeScript developers adding speech or language API capabilities to applications.
- Teams implementing live audio transcription or text-to-speech streaming.
Documented uses
- Send live audio to a speech-recognition WebSocket and receive result messages.
- Integrate transcription for prerecorded audio files.
- Connect application workflows to text-to-speech and language-understanding APIs.
Requirements & limits
The repository is public and identifies the SDK as MIT-licensed. The README specifies Node.js 18+ and installation through npm.
- The SDK covers speech recognition, text-to-speech and language-understanding API use.
- Streaming connections start closed; register handlers, connect, and wait for the connection to open before sending data.
- Browser WebSocket use is documented, while browser REST calls require a proxy because of CORS restrictions.
- Async iteration supports one active iterator per connection and has a queue cap of 1,000 messages or 16 MiB.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up a live transcription WebSocket connection
Connect an application to the documented Listen v1 streaming speech-recognition client and send audio.
Before you start
- The installed
@deepgram/sdkpackage - A Deepgram API key configured for the client
- Audio data to send
Steps
Create a
DeepgramClientand callclient.listen.v1.connect()with options such as a model and language.Register connection event handlers, such as a message handler for
Results.Call
connect()and awaitwaitForOpen().Send audio data with
sendMedia().
Expected outcome
The application is set up to send live audio and receive speech-recognition result messages through the WebSocket connection.
Guide limitations
- The guide documents the client sequence, not a verified runtime result.
- The README states that the connection starts closed and must be connected before sending data.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 13 October 2026
- Original website title
- deepgram/deepgram-js-sdk · Official homepage title · retained in its source language

