@deepgram/sdk 4.11.1 → 5.0.0-alpha.1

package/README.md

@@ -1,93 +1,15 @@
-# Deepgram JavaScript SDK
-
-[![Static Badge](https://img.shields.io/badge/%24__-Discord-blue?logo=discord&logoColor=white&link=https%3A%2F%2Fdiscord.gg%2Fdeepgram)](https://discord.gg/deepgram) [![CI](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml/badge.svg)](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [![npm (scoped)](https://img.shields.io/npm/v/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
-
-> 🎯 **Development Setup**: This project uses [Corepack](https://nodejs.org/api/corepack.html) for package manager consistency. Run `corepack enable` once, then use `pnpm` commands normally. See [DEVELOPMENT.md](./DEVELOPMENT.md) for details.
-
-<!-- TOC -->
-- [Documentation](#documentation)
-- [Migrating from earlier versions](#migrating-from-earlier-versions)
-  - [V2 to V3](#v2-to-v3)
-  - [V3.\* to V3.4](#v3-to-v34)
-  - [V3.\* to V4](#v3-to-v4)
-- [Installation](#installation)
-  - [UMD](#umd)
-  - [ESM](#esm)
-- [Initialization](#initialization)
-  - [Getting an API Key](#getting-an-api-key)
-- [Scoped Configuration](#scoped-configuration)
-  - [Global Defaults](#global-defaults)
-  - [Namespace-specific Configurations](#namespace-specific-configurations)
-  - [Transport Options](#transport-options)
-  - [Examples](#examples)
-    - [Change the API url used for all SDK methods](#change-the-api-url-used-for-all-sdk-methods)
-    - [Change the API url used for the Voice Agent websocket](#change-the-api-url-used-for-the-voice-agent-websocket)
-    - [Change the API url used for transcription only](#change-the-api-url-used-for-transcription-only)
-    - [Override fetch transmitter](#override-fetch-transmitter)
-    - [Proxy requests in the browser](#proxy-requests-in-the-browser)
-    - [Set custom headers for fetch](#set-custom-headers-for-fetch)
-- [Browser Usage](#browser-usage)
-- [Transcription](#transcription)
-  - [Remote Files](#remote-files)
-  - [Local Files](#local-files)
-  - [Callbacks / Async](#callbacks--async)
-  - [Live Transcription (WebSocket)](#live-transcription-websocket)
-  - [Captions](#captions)
-- [Voice Agent](#voice-agent)
-- [Text to Speech](#text-to-speech)
-  - [Single-Request](#single-request)
-  - [Continuous Text Stream (WebSocket)](#continuous-text-stream-websocket)
-- [Text Intelligence](#text-intelligence)
-- [Authentication](#authentication)
-  - [Get Token Details](#get-token-details)
-  - [Grant Token](#grant-token)
-- [Projects](#projects)
-  - [Get Projects](#get-projects)
-  - [Get Project](#get-project)
-  - [Update Project](#update-project)
-  - [Delete Project](#delete-project)
-- [Keys](#keys)
-  - [List Keys](#list-keys)
-  - [Get Key](#get-key)
-  - [Create Key](#create-key)
-  - [Delete Key](#delete-key)
-- [Members](#members)
-  - [Get Members](#get-members)
-  - [Remove Member](#remove-member)
-- [Scopes](#scopes)
-  - [Get Member Scopes](#get-member-scopes)
-  - [Update Scope](#update-scope)
-- [Invitations](#invitations)
-  - [List Invites](#list-invites)
-  - [Send Invite](#send-invite)
-  - [Delete Invite](#delete-invite)
-  - [Leave Project](#leave-project)
-- [Usage](#usage)
-  - [Get All Requests](#get-all-requests)
-  - [Get Request](#get-request)
-  - [Summarize Usage](#summarize-usage)
-  - [Get Fields](#get-fields)
-  - [Summarize Usage](#summarize-usage)
-- [Billing](#billing)
-  - [Get All Balances](#get-all-balances)
-  - [Get Balance](#get-balance)
-- [Models](#models)
-  - [Get All Project Models](#get-all-project-models)
-  - [Get Model](#get-model)
-- [On-Prem APIs](#on-prem-apis)
-  - [List On-Prem credentials](#list-on-prem-credentials)
-  - [Get On-Prem credentials](#get-on-prem-credentials)
-  - [Create On-Prem credentials](#create-on-prem-credentials)
-  - [Delete On-Prem credentials](#delete-on-prem-credentials)
-- [Backwards Compatibility](#backwards-compatibility)
-- [Development and Contributing](#development-and-contributing)
-  - [Debugging and making changes locally](#debugging-and-making-changes-locally)
-- [Getting Help](#getting-help)
-<!-- /TOC -->
+# Deepgram API TypeScript Library
+
+![](https://developers.deepgram.com)
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fdeepgram%2Fdeepgram-js-sdk)
+[![npm shield](https://img.shields.io/npm/v/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk)
+
+Power your apps with world-class speech and Language AI models
 
 ## Documentation
 
-You can learn more about the Deepgram API at [developers.deepgram.com](https://developers.deepgram.com/docs).
+API reference documentation is available [here](https://developers.deepgram.com/reference/deepgram-api-overview).
 
 ## Migrating from earlier versions
 
@@ -103,78 +25,102 @@ We recommend using only documented interfaces, as we strictly follow semantic ve
 
 The Voice Agent interfaces have been updated to use the new Voice Agent V1 API. Please refer to our [Documentation](https://developers.deepgram.com/docs/voice-agent-v1-migration) on Migration to new V1 Agent API.
 
-## Installation
+### V4 to V5
 
-You can install this SDK directly from [[npm](https://www.npmjs.com/package/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk).
+The SDK has been rebuilt using [Fern](https://buildwithfern.com) for auto-generation, providing better TypeScript support and a more structured API. **See [MIGRATION_GUIDE_V4_TO_V5.md](https://github.com/deepgram/deepgram-js-sdk/blob/naomi/autogenerated/MIGRATION_GUIDE_V4_TO_V5.md) for a comprehensive migration guide.**
 
-```bash
-npm install @deepgram/sdk
-```
+Key breaking changes:
+- Client initialization: `createClient()` → `new DeepgramClient()`
+- Options property: `key` → `apiKey`
+- API methods now include version namespaces (e.g., `listen.v1.media.transcribeUrl()`)
+- Error handling: Use try/catch instead of `{ result, error }` pattern
 
-or
+## Installation
 
-```bash
-pnpm install @deepgram/sdk
+```sh
+npm i -s @deepgram/sdk
 ```
 
-or
+## Authentication
 
-```bash
-yarn add @deepgram/sdk
-```
+The Deepgram SDK supports three authentication methods:
 
-### UMD
+### 1. API Key Authentication (Recommended)
 
-You can now use plain `<script>`s to import deepgram from CDNs, like:
+Uses `Token` scheme in Authorization header.
 
-```html
-<script src="https://cdn.jsdelivr.net/npm/@deepgram/sdk"></script>
-```
+```js
+import { DeepgramClient } from "@deepgram/sdk";
 
-or even:
+// Method 1: Pass API key in options object
+const deepgramClient = new DeepgramClient({ apiKey: "YOUR_DEEPGRAM_API_KEY" });
 
-```html
-<script src="https://unpkg.com/@deepgram/sdk"></script>
+// Method 2: Use environment variable (DEEPGRAM_API_KEY)
+const deepgramClient = new DeepgramClient();
 ```
 
-Then you can use it from a global deepgram variable:
+### 2. Access Token Authentication
 
-```html
-<script>
-  const { createClient } = deepgram;
-  const deepgramClient = createClient("deepgram-api-key");
+Uses `Bearer` scheme in Authorization header. Access tokens are temporary (30-second TTL) and must be obtained using an API key.
 
-  console.log("Deepgram client instance: ", deepgramClient);
-  // ...
-</script>
+```js
+import { DeepgramClient } from "@deepgram/sdk";
+
+// Pass access token as apiKey property
+const deepgramClient = new DeepgramClient({ accessToken: "YOUR_ACCESS_TOKEN" });
+
+// Or use environment variable (DEEPGRAM_ACCESS_TOKEN)
+const deepgramClient = new DeepgramClient();
 ```
 
-### ESM
+### 3. Proxy Authentication
 
-You can now use type="module" `<script>`s to import deepgram from CDNs, like:
+For browser environments or custom proxy setups. Pass `"proxy"` as the API key.
 
-```html
-<script type="module">
-  import { createClient } from "https://cdn.jsdelivr.net/npm/@deepgram/sdk/+esm";
-  const deepgramClient = createClient("deepgram-api-key");
+```js
+import { DeepgramClient } from "@deepgram/sdk";
 
-  console.log("Deepgram client instance: ", deepgramClient);
-  // ...
-</script>
+const deepgramClient = new DeepgramClient({
+  apiKey: "proxy",
+  baseUrl: "http://localhost:8080"
+});
 ```
 
-## Initialization
+> **Important**: Your proxy must set the `Authorization: token DEEPGRAM_API_KEY` header and forward requests to Deepgram's API.
+
+### Getting Credentials
 
-All of the examples below will require createClient.
+#### API Keys
+
+Create API keys via the Management API:
 
 ```js
-import { createClient } from "@deepgram/sdk";
-// - or -
-// const { createClient } = require("@deepgram/sdk");
+const data = await deepgramClient.manage.v1.keys.create(projectId, {
+  comment: "My API key",
+  scopes: ["usage:write"],
+});
+```
+
+**Endpoint**: `POST https://api.deepgram.com/v1/projects/:projectId/keys`
+
+#### Access Tokens
+
+Generate temporary access tokens (requires existing API key):
 
-const deepgramClient = createClient(DEEPGRAM_API_KEY);
+```js
+const data = await deepgramClient.auth.v1.tokens.grant();
+// Returns: { access_token: string, expires_in: 30 }
 ```
 
+**Endpoint**: `POST https://api.deepgram.com/v1/auth/grant`
+
+### Environment Variables
+
+The SDK automatically checks for credentials in this priority order:
+
+1. `DEEPGRAM_ACCESS_TOKEN` (highest priority)
+2. `DEEPGRAM_API_KEY` (fallback)
+
 ### Getting an API Key
 
 🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
@@ -209,12 +155,13 @@ This configuration system enables robust customization where defaults provide a
 Useful for using different API environments (for e.g. beta).
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 // - or -
-// const { createClient } = require("@deepgram/sdk");
+// const { DeepgramClient } = require("@deepgram/sdk");
 
-const deepgramClient = createClient(DEEPGRAM_API_KEY, {
-  global: { fetch: { options: { url: "https://api.beta.deepgram.com" } } },
+const deepgramClient = new DeepgramClient({
+  apiKey: DEEPGRAM_API_KEY,
+  baseUrl: "https://api.beta.deepgram.com"
 });
 ```
 
@@ -223,12 +170,13 @@ const deepgramClient = createClient(DEEPGRAM_API_KEY, {
 Useful for using a voice agent proxy (for e.g. 3rd party provider auth).
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 // - or -
-// const { createClient } = require("@deepgram/sdk");
+// const { DeepgramClient } = require("@deepgram/sdk");
 
-const deepgramClient = createClient(DEEPGRAM_API_KEY, {
-  global: { websocket: { options: { url: "ws://localhost:8080" } } },
+const deepgramClient = new DeepgramClient({
+  apiKey: DEEPGRAM_API_KEY,
+  baseUrl: "ws://localhost:8080"
 });
 ```
 
@@ -237,12 +185,13 @@ const deepgramClient = createClient(DEEPGRAM_API_KEY, {
 Useful for on-prem installations. Only affects requests to `/listen` endpoints.
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 // - or -
-// const { createClient } = require("@deepgram/sdk");
+// const { DeepgramClient } = require("@deepgram/sdk");
 
-const deepgramClient = createClient(DEEPGRAM_API_KEY, {
-  listen: { fetch: { options: { url: "http://localhost:8080" } } },
+const deepgramClient = new DeepgramClient({
+  apiKey: DEEPGRAM_API_KEY,
+  baseUrl: "http://localhost:8080"
 });
 ```
 
@@ -251,16 +200,17 @@ const deepgramClient = createClient(DEEPGRAM_API_KEY, {
 Useful for providing a custom http client.
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 // - or -
-// const { createClient } = require("@deepgram/sdk");
+// const { DeepgramClient } = require("@deepgram/sdk");
 
 const yourFetch = async () => {
   return Response("...etc");
 };
 
-const deepgramClient = createClient(DEEPGRAM_API_KEY, {
-  global: { fetch: { client: yourFetch } },
+const deepgramClient = new DeepgramClient({
+  apiKey: DEEPGRAM_API_KEY,
+  fetch: yourFetch
 });
 ```
 
@@ -269,10 +219,11 @@ const deepgramClient = createClient(DEEPGRAM_API_KEY, {
 This SDK now works in the browser. If you'd like to make REST-based requests (pre-recorded transcription, on-premise, and management requests), then you'll need to use a proxy as we do not support custom CORS origins on our API. To set up your proxy, you configure the SDK like so:
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 
-const deepgramClient = createClient("proxy", {
-  global: { fetch: { options: { proxy: { url: "http://localhost:8080" } } } },
+const deepgramClient = new DeepgramClient({
+  apiKey: "proxy",
+  baseUrl: "http://localhost:8080"
 });
 ```
 
@@ -287,18 +238,54 @@ Check out our example Node-based proxy here: [Deepgram Node Proxy](https://githu
 Useful for many things.
 
 ```js
-import { createClient } from "@deepgram/sdk";
+import { DeepgramClient } from "@deepgram/sdk";
 
-const deepgramClient = createClient("proxy", {
-  global: { fetch: { options: { headers: { "x-custom-header": "foo" } } } },
+const deepgramClient = new DeepgramClient({
+  apiKey: "YOUR_API_KEY",
+  headers: { "x-custom-header": "foo" }
 });
 ```
 
 ## Browser Usage
 
-To use this SDK in the browser, check out [UMD](#umd) and/or [ESM](#esm) initialisation.
+The SDK works in modern browsers with some considerations:
+
+### WebSocket Features (Full Support)
 
-Also see [proxy requests in the browser](#proxy-requests-in-the-browser) if you're planning to make RESTful requests to our API.
+- **Live Transcription**: ✅ Direct connection to `wss://api.deepgram.com`
+- **Voice Agent**: ✅ Direct connection to `wss://agent.deepgram.com`
+- **Live Text-to-Speech**: ✅ Direct connection to `wss://api.deepgram.com`
+
+### REST API Features (Proxy Required)
+
+- **Pre-recorded Transcription**: ⚠️ Requires proxy due to CORS
+- **Text Intelligence**: ⚠️ Requires proxy due to CORS
+- **Management APIs**: ⚠️ Requires proxy due to CORS
+
+### Setup Options
+
+#### Option 1: CDN (UMD)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@deepgram/sdk"></script>
+<script>
+  const { DeepgramClient } = deepgram;
+  const deepgramClient = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
+</script>
+```
+
+#### Option 2: CDN (ESM)
+
+```html
+<script type="module">
+  import { DeepgramClient } from "https://cdn.jsdelivr.net/npm/@deepgram/sdk/+esm";
+  const deepgramClient = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
+</script>
+```
+
+#### Option 3: Proxy for REST APIs
+
+See [proxy requests in the browser](#proxy-requests-in-the-browser) for REST API access.
 
 ## Transcription
 
@@ -307,15 +294,15 @@ Also see [proxy requests in the browser](#proxy-requests-in-the-browser) if you'
 Transcribe audio from a URL.
 
 ```js
-const { result, error } = await deepgramClient.listen.prerecorded.transcribeUrl(
-  { url: "https://dpgr.am/spacewalk.wav" },
-  {
-    model: "nova-3",
-    // pre-recorded transcription options
-  }
-);
+const data = await deepgramClient.listen.v1.media.transcribeUrl({
+  url: "https://dpgr.am/spacewalk.wav",
+  model: "nova-3",
+  // pre-recorded transcription options
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/listen`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/speech-to-text-api/listen).
 
 ### Local Files
@@ -323,7 +310,7 @@ const { result, error } = await deepgramClient.listen.prerecorded.transcribeUrl(
 Transcribe audio from a file.
 
 ```js
-const { result, error } = await deepgramClient.listen.prerecorded.transcribeFile(
+const data = await deepgramClient.listen.v1.media.transcribeFile(
   fs.createReadStream("./examples/spacewalk.wav"),
   {
     model: "nova-3",
@@ -332,25 +319,26 @@ const { result, error } = await deepgramClient.listen.prerecorded.transcribeFile
 );
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/listen`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/speech-to-text-api/listen).
 
 ### Callbacks / Async
 
-We have a `Callback` version of both `transcribeFile` and `transcribeUrl`, which simply takes a `CallbackUrl` class.
+Transcribe with a callback URL for async processing.
 
 ```js
-import { CallbackUrl } from "@deepgram/sdk";
-
-const { result, error } = await deepgramClient.listen.prerecorded.transcribeUrlCallback(
-  { url: "https://dpgr.am/spacewalk.wav" },
-  new CallbackUrl("http://callback/endpoint"),
-  {
-    model: "nova-3",
-    // pre-recorded transcription options
-  }
-);
+const data = await deepgramClient.listen.v1.media.transcribeUrl({
+  url: "https://dpgr.am/spacewalk.wav",
+  callback: "http://callback/endpoint",
+  callback_method: "POST",
+  model: "nova-3",
+  // pre-recorded transcription options
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/listen?callback=http://callback/endpoint`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/speech-to-text-api/listen).
 
 ### Live Transcription (WebSocket)
@@ -358,22 +346,35 @@ const { result, error } = await deepgramClient.listen.prerecorded.transcribeUrlC
 Connect to our websocket and transcribe live streaming audio.
 
 ```js
-const deepgramConnection = deepgramClient.listen.live({
+const deepgramConnection = await deepgramClient.listen.v1.connect({
   model: "nova-3",
+  language: "en",
+  punctuate: "true",
+  interim_results: "true",
   // live transcription options
 });
 
-deepgramConnection.on(LiveTranscriptionEvents.Open, () => {
-  deepgramConnection.on(LiveTranscriptionEvents.Transcript, (data) => {
+deepgramConnection.on("open", () => {
+  console.log("Connection opened");
+});
+
+deepgramConnection.on("message", (data) => {
+  if (data.type === "Results") {
     console.log(data);
-  });
+  }
+});
 
-  source.addListener("got-some-audio", async (event) => {
-    deepgramConnection.send(event.raw_audio_data);
-  });
+deepgramConnection.connect();
+await deepgramConnection.waitForOpen();
+
+// Send audio data
+source.addListener("got-some-audio", async (event) => {
+  deepgramConnection.socket.send(event.raw_audio_data);
 });
 ```
 
+**WebSocket Endpoint**: `wss://api.deepgram.com/v1/listen`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/speech-to-text-api/listen-streaming).
 
 ### Captions
@@ -383,13 +384,14 @@ Convert deepgram transcriptions to captions.
 ```js
 import { webvtt, srt } from "@deepgram/sdk";
 
-const { result, error } = await deepgramClient.listen.prerecorded.transcribeUrl({
+const data = await deepgramClient.listen.v1.media.transcribeUrl({
+  url: "https://dpgr.am/spacewalk.wav",
   model: "nova-3",
   // pre-recorded transcription options
 });
 
-const vttResult = webvtt(result);
-const srtResult = srt(result);
+const vttResult = webvtt(data);
+const srtResult = srt(data);
 ```
 
 [See our standalone captions library for more information](https://github.com/deepgram/deepgram-node-captions).
@@ -399,31 +401,53 @@ const srtResult = srt(result);
 Configure a Voice Agent.
 
 ```js
-import { AgentEvents } from "@deepgram/sdk";
-
 // Create an agent connection
-const deepgramConnection = deepgramClient.agent();
+const deepgramConnection = await deepgramClient.agent.v1.connect();
 
 // Set up event handlers
-deepgramConnection.on(AgentEvents.Open, () => {
+deepgramConnection.on("open", () => {
   console.log("Connection opened");
+});
 
-  // Set up event handlers
-  deepgramConnection.on(AgentEvents.ConversationText, (data) => {
+deepgramConnection.on("message", (data) => {
+  if (data.type === "ConversationText") {
     console.log(data);
-  });
-
-  // other events
+  }
+});
 
-  // Configure the agent once connection is established
-  deepgramConnection.configure({
-    // agent configuration
-  });
+deepgramConnection.connect();
+await deepgramConnection.waitForOpen();
 
-  // etc...
+// Configure the agent once connection is established
+deepgramConnection.sendAgentV1Settings({
+  type: "Settings",
+  agent: {
+    language: "en",
+    listen: {
+      provider: {
+        type: "deepgram",
+        model: "nova-3"
+      }
+    },
+    think: {
+      provider: {
+        type: "open_ai",
+        model: "gpt-4o-mini"
+      },
+      prompt: "You are a friendly AI assistant."
+    },
+    speak: {
+      provider: {
+        type: "deepgram",
+        model: "aura-2-thalia-en"
+      }
+    }
+  }
 });
 ```
 
+**WebSocket Endpoint**: `wss://agent.deepgram.com/v1/agent/converse`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/voice-agent-api/agent).
 
 ## Text to Speech
@@ -433,15 +457,17 @@ deepgramConnection.on(AgentEvents.Open, () => {
 Convert text into speech using the REST API.
 
 ```js
-const { result } = await deepgramClient.speak.request(
-  { text },
-  {
-    model: "aura-2-thalia-en",
-    // text to speech options
-  }
-);
+const data = await deepgramClient.speak.v1.audio.generate({
+  text: "Hello, world!",
+  model: "aura-2-thalia-en",
+  encoding: "linear16",
+  container: "wav",
+  // text to speech options
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/speak`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/text-to-speech-api/speak).
 
 ### Continuous Text Stream (WebSocket)
@@ -449,26 +475,38 @@ const { result } = await deepgramClient.speak.request(
 Connect to our websocket and send a continuous text stream to generate speech.
 
 ```js
-const deepgramConnection = deepgramClient.speak.live({
+const deepgramConnection = await deepgramClient.speak.v1.connect({
   model: "aura-2-thalia-en",
+  encoding: "linear16",
+  sample_rate: 24000,
   // live text to speech options
 });
 
-deepgramConnection.on(LiveTTSEvents.Open, () => {
+deepgramConnection.on("open", () => {
   console.log("Connection opened");
+});
 
-  // Send text data for TTS synthesis
-  deepgramConnection.sendText(text);
-
-  // Send Flush message to the server after sending the text
-  deepgramConnection.flush();
+deepgramConnection.on("message", (data) => {
+  if (typeof data === "string") {
+    // Audio data as base64 string
+    const audioBuffer = Buffer.from(data, "base64");
+    // Handle audio
+  }
+});
 
-  deepgramConnection.on(LiveTTSEvents.Close, () => {
-    console.log("Connection closed");
-  });
+deepgramConnection.on("close", () => {
+  console.log("Connection closed");
 });
+
+deepgramConnection.connect();
+await deepgramConnection.waitForOpen();
+
+// Send text data for TTS synthesis
+deepgramConnection.sendSpeakV1Text({ type: "Text", text: "Hello, world!" });
 ```
 
+**WebSocket Endpoint**: `wss://api.deepgram.com/v1/speak`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/text-to-speech-api/speak-streaming).
 
 ## Text Intelligence
@@ -480,38 +518,47 @@ const text = `The history of the phrase 'The quick brown fox jumps over the
 lazy dog'. The earliest known appearance of the phrase was in The Boston
 Journal...`;
 
-const { result, error } = await deepgramClient.read.analyzeText(
-  { text },
-  {
-    language: "en",
-    // text intelligence options
-  }
-);
+const data = await deepgramClient.read.v1.text.analyze({
+  text,
+  language: "en",
+  // text intelligence options
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/read`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/text-intelligence-api/text-read).
 
-## Authentication
+## Token Management
 
 ### Get Token Details
 
 Retrieves the details of the current authentication token.
 
 ```js
-const { result, error } = await deepgramClient.manage.getTokenDetails();
+const data = await deepgramClient.auth.v1.tokens.get();
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/auth/token`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/authentication)
 
-### Grant Token
+### Grant Access Token
 
-Creates a temporary token with a 30-second TTL.
+Creates a temporary access token with a 30-second TTL. Requires an existing API key for authentication.
 
 ```js
-const { result, error } = await deepgramClient.auth.grantToken();
+// Create a temporary access token
+const data = await deepgramClient.auth.v1.tokens.grant();
+// Returns: { access_token: string, expires_in: 30 }
+
+// Use the access token in a new client instance
+const tempClient = new DeepgramClient({ apiKey: data.access_token });
 ```
 
-This example shows how to use the temporary token to authenticate a client instance. Note that you _must_ pass an `accessToken` property to use a temporary token. Passing the token as a raw string will error, as the SDK will treat it as an API key and use the incorrect header prefix.
+**API Endpoint**: `POST https://api.deepgram.com/v1/auth/grant`
+
+> **Important**: You _must_ pass an `accessToken` property to use a temporary token. Passing the token as a raw string will treat it as an API key and use the incorrect authorization scheme.
 
 [See our API reference for more info](https://developers.deepgram.com/reference/token-based-auth-api/grant-token).
 
@@ -522,9 +569,11 @@ This example shows how to use the temporary token to authenticate a client insta
 Returns all projects accessible by the API key.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjects();
+const data = await deepgramClient.manage.v1.projects.list();
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-projects).
 
 ### Get Project
@@ -532,9 +581,11 @@ const { result, error } = await deepgramClient.manage.getProjects();
 Retrieves a specific project based on the provided project_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProject(projectId);
+const data = await deepgramClient.manage.v1.projects.get(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-project).
 
 ### Update Project
@@ -542,9 +593,13 @@ const { result, error } = await deepgramClient.manage.getProject(projectId);
 Update a project.
 
 ```js
-const { result, error } = await deepgramClient.manage.updateProject(projectId, options);
+const data = await deepgramClient.manage.v1.projects.update(projectId, {
+  name: "Updated Project Name"
+});
 ```
 
+**API Endpoint**: `PATCH https://api.deepgram.com/v1/projects/:projectId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/update-project).
 
 ### Delete Project
@@ -552,9 +607,11 @@ const { result, error } = await deepgramClient.manage.updateProject(projectId, o
 Delete a project.
 
 ```js
-const { error } = await deepgramClient.manage.deleteProject(projectId);
+await deepgramClient.manage.v1.projects.delete(projectId);
 ```
 
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-project).
 
 ## Keys
@@ -564,9 +621,11 @@ const { error } = await deepgramClient.manage.deleteProject(projectId);
 Retrieves all keys associated with the provided project_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectKeys(projectId);
+const data = await deepgramClient.manage.v1.keys.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/keys`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/list-keys).
 
 ### Get Key
@@ -574,9 +633,11 @@ const { result, error } = await deepgramClient.manage.getProjectKeys(projectId);
 Retrieves a specific key associated with the provided project_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectKey(projectId, projectKeyId);
+const data = await deepgramClient.manage.v1.keys.get(projectId, projectKeyId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/keys/:keyId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-key).
 
 ### Create Key
@@ -584,9 +645,17 @@ const { result, error } = await deepgramClient.manage.getProjectKey(projectId, p
 Creates an API key with the provided scopes.
 
 ```js
-const { result, error } = await deepgramClient.manage.createProjectKey(projectId, options);
+const data = await deepgramClient.manage.v1.keys.create(projectId, {
+  comment: "My API key",
+  scopes: ["usage:write"], // Required: array of scope strings
+  tags: ["production"], // Optional: array of tag strings
+  time_to_live_in_seconds: 86400, // Optional: TTL in seconds
+  // OR use expiration_date: "2024-12-31T23:59:59Z" // Optional: ISO date string
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/projects/:projectId/keys`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/create-key).
 
 ### Delete Key
@@ -594,9 +663,11 @@ const { result, error } = await deepgramClient.manage.createProjectKey(projectId
 Deletes a specific key associated with the provided project_id.
 
 ```js
-const { error } = await deepgramClient.manage.deleteProjectKey(projectId, projectKeyId);
+await deepgramClient.manage.v1.keys.delete(projectId, projectKeyId);
 ```
 
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId/keys/:keyId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-key).
 
 ## Members
@@ -606,9 +677,11 @@ const { error } = await deepgramClient.manage.deleteProjectKey(projectId, projec
 Retrieves account objects for all of the accounts in the specified project_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectMembers(projectId);
+const data = await deepgramClient.manage.v1.members.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/members`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-members).
 
 ### Remove Member
@@ -616,9 +689,11 @@ const { result, error } = await deepgramClient.manage.getProjectMembers(projectI
 Removes member account for specified member_id.
 
 ```js
-const { error } = await deepgramClient.manage.removeProjectMember(projectId, projectMemberId);
+await deepgramClient.manage.v1.members.delete(projectId, projectMemberId);
 ```
 
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId/members/:memberId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/remove-member).
 
 ## Scopes
@@ -628,12 +703,14 @@ const { error } = await deepgramClient.manage.removeProjectMember(projectId, pro
 Retrieves scopes of the specified member in the specified project.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectMemberScopes(
+const data = await deepgramClient.manage.v1.members.scopes.get(
   projectId,
   projectMemberId
 );
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/members/:memberId/scopes`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-member-scopes).
 
 ### Update Scope
@@ -641,13 +718,17 @@ const { result, error } = await deepgramClient.manage.getProjectMemberScopes(
 Updates the scope for the specified member in the specified project.
 
 ```js
-const { result, error } = await deepgramClient.manage.updateProjectMemberScope(
+const data = await deepgramClient.manage.v1.members.scopes.update(
   projectId,
   projectMemberId,
-  options
+  {
+    scopes: ["usage:write", "usage:read"]
+  }
 );
 ```
 
+**API Endpoint**: `PUT https://api.deepgram.com/v1/projects/:projectId/members/:memberId/scopes`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/update-scope).
 
 ## Invitations
@@ -657,9 +738,11 @@ const { result, error } = await deepgramClient.manage.updateProjectMemberScope(
 Retrieves all invitations associated with the provided project_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectInvites(projectId);
+const data = await deepgramClient.manage.v1.invites.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/invites`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/list-invites).
 
 ### Send Invite
@@ -667,9 +750,14 @@ const { result, error } = await deepgramClient.manage.getProjectInvites(projectI
 Sends an invitation to the provided email address.
 
 ```js
-const { result, error } = await deepgramClient.manage.sendProjectInvite(projectId, options);
+const data = await deepgramClient.manage.v1.invites.create(projectId, {
+  email: "user@example.com",
+  scope: "member"
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/projects/:projectId/invites`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/send-invites).
 
 ### Delete Invite
@@ -677,9 +765,11 @@ const { result, error } = await deepgramClient.manage.sendProjectInvite(projectI
 Removes the specified invitation from the project.
 
 ```js
-const { error } = await deepgramClient.manage.deleteProjectInvite(projectId, email);
+await deepgramClient.manage.v1.invites.delete(projectId, email);
 ```
 
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId/invites/:email`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-invite).
 
 ### Leave Project
@@ -687,61 +777,29 @@ const { error } = await deepgramClient.manage.deleteProjectInvite(projectId, ema
 Removes the authenticated user from the project.
 
 ```js
-const { result, error } = await deepgramClient.manage.leaveProject(projectId);
-```
-
-[See our API reference for more info](https://developers.deepgram.com/reference/leave-project).
-
-## Usage
-
-### Get All Requests
-
-Retrieves all requests associated with the provided project_id based on the provided options.
-
-```js
-const { result, error } = await deepgramClient.manage.getProjectUsageRequests(projectId, options);
-```
-
-### Get Request
-
-Retrieves a specific request associated with the provided project_id.
-
-```js
-const { result, error } = await deepgramClient.manage.getProjectUsageRequest(projectId, requestId);
+await deepgramClient.manage.v1.invites.leave(projectId);
 ```
 
-[See our API reference for more info](https://developers.deepgram.com/reference/get-request).
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId/leave`
 
-### Summarize Usage
-
-Retrieves usage associated with the provided project_id based on the provided options.
-
-```js
-const { result, error } = await deepgramClient.manage.getProjectUsageSummary(projectId, options);
-```
-
-[See our API reference for more info](https://developers.deepgram.com/reference/summarize-usage).
+[See our API reference for more info](https://developers.deepgram.com/reference/leave-project).
 
-### Get Fields
+## Reference
 
-Lists the features, models, tags, languages, and processing method used for requests in the specified project.
+A full reference for this library is available [here](https://github.com/deepgram/deepgram-js-sdk/blob/HEAD/./reference.md).
 
-```js
-const { result, error } = await deepgramClient.manage.getProjectUsageFields(projectId, options);
-```
-
-[See our API reference for more info](https://developers.deepgram.com/reference/get-fields).
+## Usage
 
-### Summarize Usage
+Instantiate and use the client with the following:
 
-`Deprecated` Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.
+```typescript
+import { createReadStream } from "fs";
+import { DeepgramClient } from "@deepgram/sdk";
 
-```js
-const { result, error } = await deepgramClient.manage.getProjectUsage(projectId, options);
+const client = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
+await client.listen.v1.media.transcribeFile(createReadStream("path/to/file"), {});
 ```
 
-[See our API reference for more info](https://developers.deepgram.com/reference/management-api/usage/get).
-
 ## Billing
 
 ### Get All Balances
@@ -749,9 +807,11 @@ const { result, error } = await deepgramClient.manage.getProjectUsage(projectId,
 Retrieves the list of balance info for the specified project.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectBalances(projectId);
+const data = await deepgramClient.manage.v1.billing.balances.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/balances`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-all-balances).
 
 ### Get Balance
@@ -759,21 +819,35 @@ const { result, error } = await deepgramClient.manage.getProjectBalances(project
 Retrieves the balance info for the specified project and balance_id.
 
 ```js
-const { result, error } = await deepgramClient.manage.getProjectBalance(projectId, balanceId);
+const data = await deepgramClient.manage.v1.billing.balances.get(projectId, balanceId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/balances/:balanceId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/get-balance).
 
 ## Models
 
+### Get All Models
+
+Retrieves all models available globally.
+
+```js
+const data = await deepgramClient.manage.v1.models.list();
+```
+
+**API Endpoint**: `GET https://api.deepgram.com/v1/models`
+
 ### Get All Project Models
 
 Retrieves all models available for a given project.
 
 ```js
-const { result, error } = await deepgramClient.manage.getAllModels(projectId, {});
+const data = await deepgramClient.manage.v1.models.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/models`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/management-api/projects/list-models).
 
 ### Get Model
@@ -781,9 +855,11 @@ const { result, error } = await deepgramClient.manage.getAllModels(projectId, {}
 Retrieves details of a specific model.
 
 ```js
-const { result, error } = await deepgramClient.manage.getModel(projectId, modelId);
+const data = await deepgramClient.manage.v1.models.get(projectId, modelId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/models/:modelId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/management-api/models/get)
 
 ## On-Prem APIs
@@ -793,9 +869,11 @@ const { result, error } = await deepgramClient.manage.getModel(projectId, modelI
 Lists sets of distribution credentials for the specified project.
 
 ```js
-const { result, error } = await deepgramClient.onprem.listCredentials(projectId);
+const data = await deepgramClient.selfHosted.v1.distributionCredentials.list(projectId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/onprem/distribution/credentials`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/self-hosted-api/list-credentials)
 
 ### Get On-Prem credentials
@@ -803,9 +881,11 @@ const { result, error } = await deepgramClient.onprem.listCredentials(projectId)
 Returns a set of distribution credentials for the specified project.
 
 ```js
-const { result, error } = await deepgramClient.onprem.getCredentials(projectId, credentialId);
+const data = await deepgramClient.selfHosted.v1.distributionCredentials.get(projectId, credentialId);
 ```
 
+**API Endpoint**: `GET https://api.deepgram.com/v1/projects/:projectId/onprem/distribution/credentials/:credentialsId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/self-hosted-api/get-credentials)
 
 ### Create On-Prem credentials
@@ -813,9 +893,13 @@ const { result, error } = await deepgramClient.onprem.getCredentials(projectId,
 Creates a set of distribution credentials for the specified project.
 
 ```js
-const { result, error } = await deepgramClient.onprem.createCredentials(projectId, options);
+const data = await deepgramClient.selfHosted.v1.distributionCredentials.create(projectId, {
+  comment: "Production credentials"
+});
 ```
 
+**API Endpoint**: `POST https://api.deepgram.com/v1/projects/:projectId/onprem/distribution/credentials`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/self-hosted-api/create-credentials)
 
 ### Delete On-Prem credentials
@@ -823,9 +907,11 @@ const { result, error } = await deepgramClient.onprem.createCredentials(projectI
 Deletes a set of distribution credentials for the specified project.
 
 ```js
-const { result, error } = await deepgramClient.onprem.deleteCredentials(projectId, credentialId);
+await deepgramClient.selfHosted.v1.distributionCredentials.delete(projectId, credentialId);
 ```
 
+**API Endpoint**: `DELETE https://api.deepgram.com/v1/projects/:projectId/onprem/distribution/credentials/:credentialsId`
+
 [See our API reference for more info](https://developers.deepgram.com/reference/self-hosted-api/delete-credentials)
 
 ## Backwards Compatibility
@@ -852,3 +938,651 @@ project, let us know! You can either:
 - [Open an issue in this repository](https://github.com/deepgram/deepgram-node-sdk/issues/new)
 - [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
 - [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Deepgram } from "@deepgram/sdk";
+
+const request: Deepgram.GrantV1Request = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { DeepgramError } from "@deepgram/sdk";
+
+try {
+    await client.listen.v1.media.transcribeFile(...);
+} catch (err) {
+    if (err instanceof DeepgramError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+        console.log(err.rawResponse);
+    }
+}
+```
+
+## File Uploads
+
+You can upload files using the client:
+
+```typescript
+import { createReadStream } from "fs";
+
+await client.listen.v1.media.transcribeFile(createReadStream("path/to/file"), ...);
+await client.listen.v1.media.transcribeFile(new ReadableStream(), ...);
+await client.listen.v1.media.transcribeFile(Buffer.from('binary data'), ...);
+await client.listen.v1.media.transcribeFile(new Blob(['binary data'], { type: 'audio/mpeg' }), ...);
+await client.listen.v1.media.transcribeFile(new File(['binary data'], 'file.mp3'), ...);
+await client.listen.v1.media.transcribeFile(new ArrayBuffer(8), ...);
+await client.listen.v1.media.transcribeFile(new Uint8Array([0, 1, 2]), ...);
+```
+The client accepts a variety of types for file upload parameters:
+* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
+* Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
+
+### Metadata
+
+You can configure metadata when uploading a file:
+```typescript
+const file: Uploadable.WithMetadata = {
+    data: createReadStream("path/to/file"),
+    filename: "my-file",       // optional
+    contentType: "audio/mpeg", // optional
+    contentLength: 1949,       // optional
+};
+```
+
+Alternatively, you can upload a file directly from a file path:
+```typescript
+const file : Uploadable.FromPath = {
+    path: "path/to/file",
+    filename: "my-file",        // optional
+    contentType: "audio/mpeg",  // optional
+    contentLength: 1949,        // optional
+};
+```
+
+The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-Disposition` headers. If not provided, the client will attempt to determine them automatically.
+For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
+
+
+## Binary Response
+
+You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
+
+```typescript
+const response = await client.speak.v1.audio.generate(...);
+const stream: ReadableStream<Uint8Array> = response.stream();
+// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
+// const blob: Blob = response.blob();
+// const bytes: Uint8Array = response.bytes();
+// You can only use the response body once, so you must choose one of the above methods.
+// If you want to check if the response body has been used, you can use the following property.
+const bodyUsed = response.bodyUsed;
+```
+<details>
+<summary>Save binary response to a file</summary>
+
+<blockquote>
+<details>
+<summary>Node.js</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+import { createWriteStream } from 'fs';
+import { Readable } from 'stream';
+import { pipeline } from 'stream/promises';
+
+const response = await client.speak.v1.audio.generate(...);
+
+const stream = response.stream();
+const nodeStream = Readable.fromWeb(stream);
+const writeStream = createWriteStream('path/to/file');
+
+await pipeline(nodeStream, writeStream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.speak.v1.audio.generate(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await writeFile('path/to/file', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.speak.v1.audio.generate(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await writeFile('output.bin', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.speak.v1.audio.generate(...);
+
+const bytes = await response.bytes();
+await writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bun</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const stream = response.stream();
+await Bun.write('path/to/file', stream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Bun.write('path/to/file', arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const blob = await response.blob();
+await Bun.write('path/to/file', blob);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const bytes = await response.bytes();
+await Bun.write('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Deno</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const stream = response.stream();
+const file = await Deno.open('path/to/file', { write: true, create: true });
+await stream.pipeTo(file.writable);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const bytes = await response.bytes();
+await Deno.writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Browser</summary>
+
+<blockquote>
+<details>
+<summary>Blob (most-efficient)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const stream = response.stream();
+const reader = stream.getReader();
+const chunks = [];
+
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  chunks.push(value);
+}
+
+const blob = new Blob(chunks);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const blob = new Blob([arrayBuffer]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const bytes = await response.bytes();
+const blob = new Blob([bytes]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<details>
+<summary>Convert binary response to text</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const stream = response.stream();
+const text = await new Response(stream).text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const text = new TextDecoder().decode(arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const blob = await response.blob();
+const text = await blob.text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.speak.v1.audio.generate(...);
+
+const bytes = await response.bytes();
+const text = new TextDecoder().decode(bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+
+## Advanced
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+const response = await client.listen.v1.media.transcribeFile(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.listen.v1.media.transcribeFile(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.listen.v1.media.transcribeFile(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.listen.v1.media.transcribeFile(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.listen.v1.media.transcribeFile(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.listen.v1.media.transcribeFile(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### Logging
+
+The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
+
+```typescript
+import { DeepgramClient, logging } from "@deepgram/sdk";
+
+const client = new DeepgramClient({
+    ...
+    logging: {
+        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
+        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
+        silent: false, // defaults to true, set to false to enable logging
+    }
+});
+```
+The `logging` object can have the following properties:
+- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
+- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
+- `silent`: Whether to silence the logger. Defaults to `true`.
+
+The `level` property can be one of the following values:
+- `logging.LogLevel.Debug`
+- `logging.LogLevel.Info`
+- `logging.LogLevel.Warn`
+- `logging.LogLevel.Error`
+
+To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
+
+<details>
+<summary>Custom logger examples</summary>
+
+Here's an example using the popular `winston` logging library.
+```ts
+import winston from 'winston';
+
+const winstonLogger = winston.createLogger({...});
+
+const logger: logging.ILogger = {
+    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
+    info: (msg, ...args) => winstonLogger.info(msg, ...args),
+    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
+    error: (msg, ...args) => winstonLogger.error(msg, ...args),
+};
+```
+
+Here's an example using the popular `pino` logging library.
+
+```ts
+import pino from 'pino';
+
+const pinoLogger = pino({...});
+
+const logger: logging.ILogger = {
+  debug: (msg, ...args) => pinoLogger.debug(args, msg),
+  info: (msg, ...args) => pinoLogger.info(args, msg),
+  warn: (msg, ...args) => pinoLogger.warn(args, msg),
+  error: (msg, ...args) => pinoLogger.error(args, msg),
+};
+```
+</details>
+
+
+### Runtime Compatibility
+
+
+The SDK works in the following runtimes:
+
+
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { DeepgramClient } from "@deepgram/sdk";
+
+const client = new DeepgramClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!