5.4.0 (2026-06-01)
- transport: add pluggable streaming-transport interface for SageMaker support. New
DeepgramTransport/DeepgramTransportFactoryinterface (src/transport.ts) and atransportFactoryoption onDeepgramClient; when set, thelisten.v1,listen.v2,speak.v1, andagent.v1createConnectionpaths route through a custom transport via aTransportWebSocketAdapterinstead of the default WebSocket. REST behaviour is unchanged. This is the seam the@deepgram/sagemakerpackage plugs into (#492) (4d43b1b) - transport: add
reconnectflag with auto-disable for custom transports. New optionalreconnect?: booleanonDeepgramClient(defaulttrue, exposed read-only asclient.reconnect) controlling wrapper-level retry of streaming connections; auto-disabled tofalsewhen atransportFactoryis supplied so self-retrying transports aren't double-stacked with a second retry layer (8dec8c9)
- types: expose WebSocket helper types so
client.listen.v1.createConnection({ model })type-checks andAuthorizationis optional on theagent/listen/speakconnect helpers. Runtime behaviour is unchanged (types-only fix); fixes #489 (#501) (ac71def)
5.3.0 (2026-05-15)
- listen: Diarization v2 is now GA for batch transcription. New optional
diarize_modelfield onListenV1RequestUrlandMediaTranscribeRequestOctetStream, plus a newMediaTranscribeRequestDiarizeModelenum (#499) (b015e1f) - agent: introduce top-level
DeepgramListenProviderV1andDeepgramListenProviderV2types that consolidate the previous per-resource provider types. The existingAgentV1SettingsAgent[Context]ListenProvider*paths continue to work, including the nestedAgentV1SettingsAgentContextListenProviderV2.LanguageHintnamespace path which is preserved as an alias forDeepgramListenProviderV2.LanguageHint(#499) (b015e1f), (ace680a) - agent: route
agent.v1.settings.think.modelsover HTTPS instead of WSS. Previously this endpoint was misrouted and was unusable (#499) (b015e1f) - environment: replace
DeepgramEnvironment.Agentwith a newagentRestslot on theProductionenvironment. Callers constructing a custom environment should passagentRestinstead of relying on the removedAgentvalue (#499) (b015e1f)
- client: restore
client.fetch()defaultbaseUrltoapi.deepgram.com. After the newagentRestenvironment slot was introduced, the passthrough helper was defaulting toagent.deepgram.com, which 404'd for canonical REST endpoints (56b8ce5)
5.2.0 (2026-05-12)
- alias AgentV1SettingsAgentListenProvider to *AgentContextListenProvider (150e663)
- preserve AgentV1Settings.Agent sub-types after regen (2efab2d)
- preserve SDK compatibility after regen (d2b8d62)
- restore Agent interface, add AgentReference for string-id flow (4c72d31)
- sdk regeneration 2026-04-30 (#491) (a618282)
- sdk regeneration 2026-05-06 with backward-compat preserved (#497) (2aed53e)
5.1.0 (2026-04-27)
- sdk regeneration 2026-04-24 (4466be0)
- ci: pin JS tooling used by PR title and example checks (7a1c1ea)
5.0.0 (2026-03-04)
- release new codegen architecture and interfaces (#447)
- the interfaces for the voice agent have changed.
- resolve lint issue
- complete rearchitecture of the Node/JavaScript SDK to work in browsers and Node.
- abstract client rebuilt for namespace options (486fd86)
- add a method to send KeepAlive ws messages (#150) (880e943)
- add lint and build to workflow (1710c46)
- add linting for yaml files (f10d10d)
- add markdown linting (899b0e9)
- add missing feature toggles from q1 feature audit (#237) (7f972d1)
- add new models endpoints to SDK (630387d)
- add SpeakClient and example (a3112bc)
- add SpeakLiveClient and LiveTTSEvents (39a535d)
- add speechstarted event to sdk (#235) (1f80bab)
- add support for new beta release of summarisation (#143) (dfecdf2)
- add timeout mechanism to WebSocket mock waitForConnection method (a663956)
- add UtteranceEnd event to sdk (#234) (82f8b2f)
- add warning metadata and summarisation result to response type (#152) (1288778)
- adds support for agent mip_opt_out (#421) (76f9653)
- adds support for IUM (aa6cee2)
- adds support for speak fallback (#414) (8e59b55)
- adds ttl_seconds support (#420) (5ed8004)
- apply luke's suggestions (517ea3c)
- auth: add support for DEEPGRAM_ACCESS_TOKEN as per the other SDKs (7924959)
- Better VTT and SRT (#141) (c3cfc28)
- configurable websocket url (73e53e3)
- convert all legacy options to namespaced options (154ba30)
- errors: enhance WebSocket error output and abstract connection setup (36778e9)
- filler words release (74a4e56)
- filler words release (11b90b8)
- finish it up! (73e53e3)
- finishing touches TTS live client (5da606d)
- i feel like i'm getting nowhere here (73e53e3)
- implement
no_delay(726f676) - implement multi-lingual (034d5b0)
- implements
finalizeon the liveclient (cee0704) - improve experience around usage of custom API endpoints (#230) (b779348)
- latest spec fixes (1a37177)
- lint the examples (744fe1a)
- make provider objects generic (b0fc5cb)
- merge in new websocket transmitter changes (565ae2c)
- Merge pull request #238 from deepgram/release/jan-minor-1 (f598162)
- migrate to agent v1 (3a8493b)
- new metadata models endpoints (630387d)
- officially enable aura-2 in live text-to-speech (6b122f9)
- plug live client into new options (8510726)
- plug rest clients into new options (e2f3d8f)
- post-EA changes (630387d)
- rebuilding config and class interfaces (501d6d0)
- release new codegen architecture and interfaces (#447) (4c56fd9)
- release voice agent (73e53e3)
- release voice agent v1 (96753f9)
- Release/3.x.x 20240427 (#271) (7a76f75)
- remove container from websocket speak options (2a03f9a)
- remove specific error typing from the method definitions (#142) (8fbbee7)
- rename reset method to clear, respond with "Clear" payload (b409f8d)
- send back raw buffer instead of ArrayBuffer (298df5c)
- set up linting for typescript (6590d73)
- simplify and standardize examples (81689db)
- sits for JS sdk (#233) (d8de666)
- speak endpoint added (279ad76)
- speak endpoint added (8948856)
- support context length option (7b22b07)
- support nova-3 and keyterms in stt (23bf960)
- support nova-3 in agent (f84761b)
- support token-based auth endpoint (3186ef2)
- switch to new websocket logic (331454e)
- test: add transcribeUrl integration test (f730d83)
- test: add useful unit tests (6093bb7)
- test: move the serializer separate of the test (8c017c0)
- tests: add e2e tests for other apis (28d33f8)
- tests: add mock api responses when tests run offline (2b004d0)
- tests: add TTS test, fix offline tests for mocks (d308561)
- tests: add websockets e2e and unit tests (5d85b4b)
- test: sensibly use fixtures for e2e test requests (028d44f)
- throw errors when using v2 callstack on the v3 SDK (#226) (e5fac7a)
- tie together namespace config with fetch and websocket options (a7a4752)
- update AbstractLiveClient to handle binary data (a7feb78)
- update for ga (73e53e3)
- Update README.md for websocket agent url change (27398b6)
- use agent directly, no live prop (73e53e3)
- Use nullish coalescing (#136) (06e03a6)
- actually send normalised config (5d7cbae)
- add jsdoc comment oops (351d709)
- add missing language specification to markdown code block (249cf40)
- add missing speech started VAD events param (7e6a5ff)
- add Node.js polyfills for webpack UMD build (5cb550b)
- adds proper wav headers to index.js for wav file creation (6739be8)
- agent timing issue (#428) (cee9b19)
- allows endpointing to be disabled with a value of false (#236) (1add378)
- auth: address PR feedback (a5f0bda)
- can't import with extensions 😩 (73e53e3)
- changed
updateInstructionsmethod toupdatePromptto match V1 (b175a1f) - ci: bump node version for semantic-release (#452) (e7fda4c)
- code snippet for live transcription. (efcca77)
- confirm token fix in example (bf1cf96)
- correct ESLint directive in test-offline.js script (bdfa175)
- correct spelling of LiveClient (ecf09df)
- default URL should have protocol included (#246) (9316d91)
- deprecation note in ListenLiveClient (a22824e)
- edit isBrowser to explicitly check for a window.document before dismissing it as not browser (5612f86)
- expand example (73e53e3)
- experimental boolean is optional (989ede8)
- fallback from undefined process variable (7ce44bd)
- fix body not being serialized somehow (a330a3c)
- fix body not being serialized somehow (00c0025)
- fix types to match current api response (#26) (eec0cde)
- fixed circular dependency giving errors under webpack (87c554b)
- fixes mips_opt_out placement (c342789)
- handle blob response, append wav header (bb5c8b2)
- helpers: checks for null as any injection bug (f16d74f)
- import errors (e301786)
- incorrect typing on extra metadata in schema (#247) (25111e9)
- instructions -> prompt in updatePrompt to align with v1 spec (16af51e)
- introduce a back-comp change to 'project.update' to accept project_id instead of object (#134) (e74947a)
- keyterms are optional (c270a80)
- keyterms to keyterm (490a2eb)
- lint (0e80a00)
- make sure process.versions without node key also works (c166430)
- make temporary auth tokens actually work (5d5a56a)
- merge clones by default (ff467bf)
- metadata response missing from analyze response (#248) (0212338)
- missing lines from merge conflict for text inteligence, add example (#242) (f3873d9)
- missing speaker in SyncPrerecordedResponse (#260) (119b53d)
- missing type for detect_language which supports multiple strings OR a single bool (ebf07a5)
- move @types/node to dependencies instead of devDependencies (18b4640)
- Multiple post-release bug fixes (#217) (7c41660)
- oops (73e53e3)
- override es5-ext to pre-vuln version. bump ejs for vuln (8756508)
- pass sample rate option (753be7e)
- process is not defined in browser demos right now (984591d)
- process is undefined error in browsers (#275) (5e51f1c)
- remove bedrock (6fa56b8)
- remove erroneous file (785aff4)
- remove model/keyterm check (ca207ec)
- resolve lint issue (98843a6)
- resolves process undefined and logs more data for browser types (b62f2e3)
- rewrite links in comments (117e7e3)
- settings object structure (5a850ea)
- some tests were hitting production (630387d)
- tests: fix the workflow (30328b3)
- tests: fixing tests (d6e09b7)
- tests: update fetchWithAuth function calls to use options object (44b0472)
- tools: remove codecov from ci (#445) (b6a8fd6)
- type definition issues on agent schema (21dcc9b)
- type fix for language in agent (a9f744c)
- typo to kick off release (6ba50f6)
- unconditional process reference (bd51da7)
- unused vars (e395c56)
- update find-and-replace to accept strings or arrays of strings (#146) (f330bdf)
- update live client tests to handle enhanced error events (9350dbf)
- update live example to demonstrate utteranceend and speechstarted (7dd99c9)
- update package.json to reflect renamed repo (a08f138)
- updated error handling to show correct info (4425879)
- updated error handling to show correct info (52aa149)
- updates for aura-2 (461bc0d)
- use correct import of EventEmitter (80e2331)
- use string fallback in union types for agent (711be7e)
- use type-only imports for Node.js stream module (de726ef)
- keyterm -> keyterms (3536b1c)
4.11.3 (2025-12-17)
4.11.2 (2025-08-06)
4.11.1 (2025-07-25)
- fixes mips_opt_out placement (c342789)
4.11.0 (2025-07-21)
4.10.0 (2025-07-21)
4.9.1 (2025-07-09)
- use type-only imports for Node.js stream module (de726ef)
4.9.0 (2025-07-08)
4.8.0 (2025-07-07)
- simplify and standardize examples (81689db)
- adds support for IUM (aa6cee2)
- add timeout mechanism to WebSocket mock waitForConnection method (a663956)
- tests: add websockets e2e and unit tests (5d85b4b)
- tests: add e2e tests for other apis (28d33f8)
- tests: add TTS test, fix offline tests for mocks (d308561)
- tests: add mock api responses when tests run offline (2b004d0)
- test: add useful unit tests (6093bb7)
- add Node.js polyfills for webpack UMD build (5cb550b)
- helpers: checks for null as any injection bug (f16d74f)
- tests: update fetchWithAuth function calls to use options object (44b0472)
- update live client tests to handle enhanced error events (9350dbf)
4.7.0 (2025-06-25)
- errors: enhance WebSocket error output and abstract connection setup (36778e9)
4.6.0 (2025-06-24)
- auth: add support for DEEPGRAM_ACCESS_TOKEN as per the other SDKs (7924959)
4.5.1 (2025-06-20)
- confirm token fix in example (bf1cf96)
4.5.0 (2025-06-20)
- apply luke's suggestions (517ea3c)
4.4.0 (2025-06-10)
- support context length option (7b22b07)
4.3.0 (2025-06-09)
- make provider objects generic (b0fc5cb)
- remove model/keyterm check (ca207ec)
- adds proper wav headers to index.js for wav file creation (6739be8)
4.2.0 (2025-05-19)
- update README.md for websocket agent url change (27398b6)
4.1.1 (2025-05-15)
- type fix for language in agent (a9f744c)
4.1.0 (2025-05-09)
- officially enable aura-2 in live text-to-speech (6b122f9)
4.0.1 (2025-05-07)
- settings object structure (5a850ea)
4.0.0 (2025-05-05)
- Voice Agent API updated to V1 spec. See migration guide.
- release voice agent v1 (96753f9)
3.13.0 (2025-05-05)
- experimental boolean is optional (989ede8)
- remove bedrock (6fa56b8)
- changed
updateInstructionsmethod toupdatePromptto match V1 (b175a1f) - instructions -> prompt in updatePrompt to align with v1 spec (16af51e)
3.12.1 (2025-04-14)
- updates for aura-2 (461bc0d)
3.12.0 (2025-04-14)
- support token-based auth endpoint (3186ef2)
3.11.3 (2025-03-26)
- fixed circular dependency giving errors under webpack (87c554b)
3.11.2 (2025-03-03)
- use string fallback in union types for agent (711be7e)
- keyterm -> keyterms (revert) (3536b1c)
- AgentLiveSchema.context type to use 'role' instead of 'type' in messages array (b39256d)
3.11.1 (2025-02-13)
- keyterms to keyterm (490a2eb)
3.11.0 (2025-02-11)
3.10.1 (2025-02-06)
- type definition issues on agent schema (21dcc9b)
3.10.0 (2025-02-03)
- actually send normalised config (5d7cbae)
3.9.0 (2024-10-23)
- set up linting for typescript (6590d73)
- add linting for yaml files (1710c46)
- add lint and build to workflow (18b4640)
- move @types/node to dependencies instead of devDependencies (18b4640)
3.8.1 (2024-10-10)
3.8.0 (2024-10-01)
- send back raw buffer instead of ArrayBuffer (298df5c)
3.7.0 (2024-09-18)
- add SpeakLiveClient and LiveTTSEvents (39a535d)
- update AbstractLiveClient to handle binary data (a7feb78)
- add SpeakClient and example (a3112bc)
- rename reset method to clear, respond with "Clear" payload (b409f8d)
3.6.0 (2024-08-29)
- add new models endpoints to SDK (630387d)
3.5.1 (2024-08-05)
- process is not defined in browser demos (984591d)
3.5.0 (2024-07-12)
- implement
no_delay(726f676) - implements
finalizeon the liveclient (cee0704) - implement multi-lingual (034d5b0)
3.4.4 (2024-07-09)
- missing type for detect_language which supports multiple strings or a single bool (ebf07a5)
3.4.3 (2024-07-09)
- use correct import of EventEmitter (80e2331)
3.4.2 (2024-07-09)
- deprecation note in ListenLiveClient (a22824e)
3.4.1 (2024-07-04)
- correct spelling of LiveClient (ecf09df)
3.4.0 (2024-07-02)
- abstract client rebuilt for namespace options (486fd86)
- rebuilding config and class interfaces (501d6d0)
- convert all legacy options to namespaced options (154ba30)
- plug live client into new options (8510726)
- plug rest clients into new options (e2f3d8f)
- tie together namespace config with fetch and websocket options (a7a4752)
- switch to new websocket logic (565ae2c)
- merge clones by default (ff467bf)
- resolves process undefined and logs more data for browser types (b62f2e3)
- edit isBrowser to explicitly check for a window.document (5612f86)
3.3.5 (2024-06-21)
3.3.4 (2024-06-06)
- make sure process.versions without node key also works (c166430)
- fallback from undefined process variable (7ce44bd)
3.3.3 (2024-05-20)
- unconditional process reference (bd51da7)
3.3.2 (2024-05-15)
- override es5-ext to pre-vuln version, bump ejs for vuln (8756508)
3.3.1 (2024-04-30)
3.3.0 (2024-04-27)
3.2.0 (2024-03-11)
- speak endpoint added (8948856)
3.1.9 (2024-02-06)
3.1.8 (2024-02-06)
3.1.7 (2024-02-06)
3.1.6 (2024-01-31)
3.1.5 (2024-01-31)
- update package.json to reflect renamed repo (a08f138)
3.1.4 (2024-01-31)
- update live example to demonstrate utteranceend and speechstarted (7dd99c9)
3.1.3 (2024-01-30)
- rewrite links in comments (117e7e3)
3.1.2 (2024-01-29)
- add missing speech started VAD events param (7e6a5ff)
3.1.1 (2024-01-25)
No notable changes.
3.1.0 (2024-01-25)
- throw errors when using v2 callstack on the v3 SDK (#226) (e5fac7a)
- improve experience around usage of custom API endpoints (#230) (b779348)
- sits for JS sdk (#233) (d8de666)
- add UtteranceEnd event to sdk (#234) (82f8b2f)
- add speechstarted event to sdk (#235) (1f80bab)
- add missing feature toggles from Q1 feature audit (#237) (7f972d1)
- allows endpointing to be disabled with a value of false (#236) (1add378)
- fix body not being serialized (a330a3c)
3.0.1 (2023-12-05)
3.0.0 (2023-11-29)
- Complete SDK rewrite. See migration guide.
2.4.0 (2023-07-27)
- filler words release (11b90b8)
2.3.0 (2023-07-19)
- add a method to send KeepAlive ws messages (#150) (880e943)
- add warning metadata and summarisation result to response type (#152) (1288778)
2.2.0 (2023-06-21)
- use nullish coalescing (#136) (06e03a6)
- better VTT and SRT (#141) (c3cfc28)
- remove specific error typing from the method definitions (#142) (8fbbee7)
- add support for new beta release of summarisation (#143) (dfecdf2)
- introduce a back-compat change to 'project.update' to accept project_id instead of object (#134) (e74947a)
2.1.1 (2023-05-24)
- updated readme to have examples of all methods (971a427)
2.1.0 (2023-05-24)
- allow arbitrary properties in the request object (9f7aecb)
2.0.0 (2023-05-15)
- Removed browser SDK code. Custom endpoint override added to all methods.
- add custom endpoint override to pre-recorded transcription (e8444b1)
- add customisable endpoint to live transcription (8573d00)
- add custom endpoint to billing (5ee5fce)
1.21.0 (2023-05-01)
- add keyword_boost to transcription options (9ed8a93)
- type of alternatives response (6b734a1)
1.20.0 (2023-04-12)
- added ner option and sentiment for tonal sentiment analysis (80f76c7)
1.19.0 (2023-04-03)
- update endpointing types to match new API (0271231)
1.18.3 (2023-03-17)
- output full error response as stringified JSON (3fea092)
1.18.2 (2023-03-16)
- added reason to close event (e44ffb8)
1.18.1 (2023-02-27)
- moving detected_language to correct type (58568cc)
1.18.0 (2023-02-23)
- match redaction parameters to spec (b5d61c2)
- fix built bundle not including nested browser types (c5a522ef)
- changed times to be optional in Options object (a9bffa2)
1.17.0 (2023-02-07)
- update prerecorded redaction types to match API (90ad713)
- update live streaming redaction types to match API (e6f95c1)
1.16.0 (2023-01-31)
- added configure function for mid-stream toggling (3eecacf)
1.15.0 (2023-01-23)
- added tag to transcription endpoints, added delete endpoint to projects (4577b9d)
1.14.0 (2022-12-12)
- add smart formatting (806eef9)
1.13.0 (2022-12-08)
1.12.2 (2022-12-06)
- bug in httprequest (1ee1ae9)
1.12.1 (2022-11-30)
- updated error handling to show correct info (52aa149)
1.12.0 (2022-11-30)
- adding SSL options (09872ea)
1.11.0 (2022-11-15)
- added formatting features to live and pre-recorded transcriptions (2d61d2c)
1.10.2 (2022-10-29)
1.10.1 (2022-10-07)
- CD action for versioning (536ad23)
1.10.0 (2022-10-07)
1.9.0 (2022-09-27)
- added summarize option (6156a14)
1.8.0 (2022-09-20)
- added detect language option to preRecordedOptions (4836d0d)
1.7.0 (2022-09-09)
- adding paragraphs feature to SDK (fc6be4b)
1.6.0 (2022-09-02)
- added better error handling in both Node and Browser SDKs (19d6859)
1.5.0 (2022-08-17)
- added updates to diarize option, updated transcription response to include speaker_confidence (#52) (03b4b66)
1.4.9 (2022-08-17)
- added updates to diarize option, updated speaker_confidence (faf6df2)
1.4.8 (2022-08-05)
- adding missing types (ec41274)
1.4.7 (2022-08-04)
1.4.6 (2022-08-05)
- issue with type files not exporting Deepgram class (ce79181)
1.4.5 (2022-08-03)
- change ReadStreamSource to accept stream.Readable instead of only fs.ReadStream (6a2d2e2)
1.4.4 (2022-07-15)
- added replace parameter (30e3a6d)
1.4.3 (2022-07-07)
- added tier to type definitions of accepted options (5b83eb6)
1.4.2 (2022-06-24)
- browser is now built to @deepgram/sdk/browser (62663fb)
1.4.1 (2022-06-23)
- fixing npm deployment (bd2d58a)
1.4.0 (2022-05-19)
- added browser live transcription option (46fdb03)
- added browser support for all management APIs (41915f2)
- added webpack config to minimize shipped code (470e102)
- added X-DG-Agent header for browser SDK tracking (bd9a7dd)
1.3.1 (2022-04-02)
1.3.0 (2022-03-22)
1.2.4 (2022-03-16)
1.2.3 (2022-03-16)
- fix types to match current api response (#26) (eec0cde)
- fixing version parameter of transcription options (a934c5e)
1.2.2 (2022-02-25)
- fixing real-time socket close bug (#22) (e432c98)
- updating wordBase object to add speaker (#18) (ad137e0)
1.2.1 (2022-02-02)
- fixing real-time socket close bug (2514269)
1.2.0 (2022-01-12)
- added the ability to create temporary keys (db808a9)
1.1.0 (2021-11-04)
1.0.3 (2021-10-29)
1.0.2 (2021-07-14)
- adding utterances and modifying property names (e83c6d1)
1.0.1 (2021-07-07)
- fixing live transcription auth (a35d86e)
1.0.0 (2021-07-07)
- version 1.0.0 release (3e307c1)
0.6.5 (2021-05-11)
- updated README to denote alpha status (259feee)
0.6.4 (2021-05-04)
- 0.6.4 release (9827fec)
0.6.3 (2021-05-04)
- update CD.yml (70c5ebd)
0.6.2 (2021-05-04)
- update package.json (bfe7716)
0.6.1 (2021-05-04)
- fixing build package (4dbfdbf)
0.6.0 (2021-05-04)
- fixed issue with key deletion (66a299c)
- initial release with transcription and key management (38c015d)