You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ Official Node.js SDK for [Deepgram](https://www.deepgram.com/). Power your apps
13
13
*[Deepgram Node.js SDK](#deepgram-nodejs-sdk)
14
14
*[Getting an API Key](#getting-an-api-key)
15
15
*[Installation](#installation)
16
-
*[Constructor](#constructor)
16
+
*[Configuration](#configuration)
17
+
*[Custom API Endpoint](#custom-api-endpoint)
17
18
*[Transcription](#transcription)
18
19
*[Remote Files](#remote-files)
19
20
*[Local Files](#local-files)
@@ -56,13 +57,17 @@ Official Node.js SDK for [Deepgram](https://www.deepgram.com/). Power your apps
56
57
57
58
# Installation
58
59
60
+
You can install the Deepgram Node.js SDK as a dependency in your application using NPM or yarn:
61
+
59
62
```bash
60
63
npm install @deepgram/sdk
61
64
# - or -
62
65
# yarn add @deepgram/sdk
63
66
```
64
67
65
-
# Constructor
68
+
# Configuration
69
+
70
+
Once the SDK is installed, import the Deepgram object. Then create a new instance specifying your API key so that your application will be authorized to connect to Deepgram.
With the Deepgram client initialized, you can now send requests to the Deepgram API to transcribe audio, manage projects & keys, and retrieve usage information.
80
+
81
+
## Custom API Endpoint
82
+
83
+
In order to point the SDK at a different API endpoint (e.g., for on-prem deployments), you can pass in an object setting the `API_URL` when initializing the Deepgram client.
84
+
85
+
```js
86
+
constREQUIRE_SSL=false; // defaults to true - set depending on server configuration
87
+
constAPI_URL="localhost:8080"; // defaults to api.deepgram.com
0 commit comments