v5.0.0

5.0.0 (2026-03-04)

⚠ BREAKING CHANGES

• 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.

Release

• JS SDK V3 (#208) (2734f69)

Features

• 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 finalize on 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)

Bug Fixes

• 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 updateInstructions method to updatePrompt to 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)

Reverts

• keyterm -> keyterms (3536b1c)