{"id":25901646,"url":"https://github.com/deepgram/deepgram-node-sdk","last_synced_at":"2025-03-03T03:01:58.915Z","repository":{"id":37910401,"uuid":"363552464","full_name":"deepgram/deepgram-js-sdk","owner":"deepgram","description":"Official JavaScript SDK for Deepgram's automated speech recognition APIs.","archived":false,"fork":false,"pushed_at":"2024-05-20T15:52:54.000Z","size":21787,"stargazers_count":118,"open_issues_count":21,"forks_count":36,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-05-21T20:13:35.632Z","etag":null,"topics":["ai","asr","automated-speech-recognition","deepgram","hacktoberfest","javascript","speech-recognition","speech-to-text","typescript"],"latest_commit_sha":null,"homepage":"https://developers.deepgram.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deepgram.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-02T02:47:24.000Z","updated_at":"2024-06-21T15:40:23.312Z","dependencies_parsed_at":"2023-10-27T13:25:47.785Z","dependency_job_id":"a447b805-21cb-4aaa-bd08-da7077db5cb5","html_url":"https://github.com/deepgram/deepgram-js-sdk","commit_stats":{"total_commits":139,"total_committers":20,"mean_commits":6.95,"dds":0.5467625899280575,"last_synced_commit":"7ba3fe846e2097161ed30537c856caab752bfe6a"},"previous_names":["deepgram/deepgram-js-sdk","deepgram/deepgram-node-sdk"],"tags_count":103,"template":false,"template_full_name":"deepgram/oss-repo-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fdeepgram-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fdeepgram-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fdeepgram-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fdeepgram-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepgram","download_url":"https://codeload.github.com/deepgram/deepgram-js-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241600486,"owners_count":19988713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","asr","automated-speech-recognition","deepgram","hacktoberfest","javascript","speech-recognition","speech-to-text","typescript"],"created_at":"2025-03-03T03:01:15.628Z","updated_at":"2025-03-03T03:01:58.904Z","avatar_url":"https://github.com/deepgram.png","language":"TypeScript","funding_links":[],"categories":["Specialised APIs"],"sub_categories":[],"readme":"# Deepgram JavaScript SDK\n\n[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) [![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)\n\nOfficial JavaScript SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models.\n\n- [Migrating from earlier versions](#migrating-from-earlier-versions)\n  - [V2 to V3](#v2-to-v3)\n  - [V3.\\* to V3.4](#v3-to-v34)\n- [Installation](#installation)\n  - [UMD](#umd)\n  - [ESM](#esm)\n- [Initialization](#initialization)\n  - [Getting an API Key](#getting-an-api-key)\n- [Scoped Configuration](#scoped-configuration)\n  - [1. Global Defaults](#1-global-defaults)\n  - [2. Namespace-specific Configurations](#2-namespace-specific-configurations)\n  - [3. Transport Options](#3-transport-options)\n  - [4. Examples](#4-examples)\n    - [Change the API url used for all SDK methods](#change-the-api-url-used-for-all-sdk-methods)\n    - [Change the API url used for transcription only](#change-the-api-url-used-for-transcription-only)\n    - [Override fetch transmitter](#override-fetch-transmitter)\n    - [Proxy requests in the browser](#proxy-requests-in-the-browser)\n    - [Set custom headers for fetch](#set-custom-headers-for-fetch)\n- [Transcription (Synchronous)](#transcription-synchronous)\n  - [Remote Files](#remote-files)\n  - [Local Files](#local-files)\n- [Transcription (Asynchronous / Callbacks)](#transcription-asynchronous--callbacks)\n  - [Remote Files](#remote-files-1)\n  - [Local Files](#local-files-1)\n- [Transcription (Live / Streaming)](#transcription-live--streaming)\n  - [Live Audio](#live-audio)\n- [Transcribing to captions](#transcribing-to-captions)\n- [Text to Speech](#text-to-speech)\n- [Text Intelligence](#text-intelligence)\n- [Projects](#projects)\n  - [Get Projects](#get-projects)\n  - [Get Project](#get-project)\n  - [Update Project](#update-project)\n  - [Delete Project](#delete-project)\n- [Keys](#keys)\n  - [List Keys](#list-keys)\n  - [Get Key](#get-key)\n  - [Create Key](#create-key)\n  - [Delete Key](#delete-key)\n- [Members](#members)\n  - [Get Members](#get-members)\n  - [Remove Member](#remove-member)\n- [Scopes](#scopes)\n  - [Get Member Scopes](#get-member-scopes)\n  - [Update Scope](#update-scope)\n- [Invitations](#invitations)\n  - [List Invites](#list-invites)\n  - [Send Invite](#send-invite)\n  - [Delete Invite](#delete-invite)\n  - [Leave Project](#leave-project)\n- [Usage](#usage)\n  - [Get All Requests](#get-all-requests)\n  - [Get Request](#get-request)\n  - [Summarize Usage](#summarize-usage)\n  - [Get Fields](#get-fields)\n- [Billing](#billing)\n  - [Get All Balances](#get-all-balances)\n  - [Get Balance](#get-balance)\n- [On-Prem APIs](#on-prem-apis)\n  - [List On-Prem credentials](#list-on-prem-credentials)\n  - [Get On-Prem credentials](#get-on-prem-credentials)\n  - [Create On-Prem credentials](#create-on-prem-credentials)\n  - [Delete On-Prem credentials](#delete-on-prem-credentials)\n- [Backwards Compatibility](#backwards-compatibility)\n- [Development and Contributing](#development-and-contributing)\n  - [Debugging and making changes locally](#debugging-and-making-changes-locally)\n- [Getting Help](#getting-help)\n\n## Migrating from earlier versions\n\n### V2 to V3\n\nWe have published [a migration guide on our docs](https://developers.deepgram.com/docs/js-sdk-v2-to-v3-migration-guide), showing how to move from v2 to v3.\n\n### V3.\\* to V3.4\n\nWe recommend using only documented interfaces, as we strictly follow semantic versioning (semver) and breaking changes may occur for undocumented interfaces. To ensure compatibility, consider pinning your versions if you need to use undocumented interfaces.\n\n## Installation\n\nYou can install this SDK directly from [npm](https://www.npmjs.com/package/@deepgram/sdk).\n\n```bash\nnpm install @deepgram/sdk\n# - or -\n# yarn add @deepgram/sdk\n```\n\n### UMD\n\nYou can now use plain `\u003cscript\u003e`s to import deepgram from CDNs, like:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@deepgram/sdk\"\u003e\u003c/script\u003e\n```\n\nor even:\n\n```html\n\u003cscript src=\"https://unpkg.com/@deepgram/sdk\"\u003e\u003c/script\u003e\n```\n\nThen you can use it from a global deepgram variable:\n\n```html\n\u003cscript\u003e\n  const { createClient } = deepgram;\n  const _deepgram = createClient(\"deepgram-api-key\");\n\n  console.log(\"Deepgram Instance: \", _deepgram);\n  // ...\n\u003c/script\u003e\n```\n\n### ESM\n\nYou can now use type=\"module\" `\u003cscript\u003e`s to import deepgram from CDNs, like:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import { createClient } from \"https://cdn.jsdelivr.net/npm/@deepgram/sdk/+esm\";\n  const deepgram = createClient(\"deepgram-api-key\");\n\n  console.log(\"Deepgram Instance: \", deepgram);\n  // ...\n\u003c/script\u003e\n```\n\n## Initialization\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n// - or -\n// const { createClient } = require(\"@deepgram/sdk\");\n\nconst deepgram = createClient(DEEPGRAM_API_KEY);\n```\n\n### Getting an API Key\n\n🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).\n\n## Scoped Configuration\n\nThe SDK supports scoped configuration. You'll be able to configure various aspects of each namespace of the SDK from the initialization. Below outlines a flexible and customizable configuration system for the Deepgram SDK. Here’s how the namespace configuration works:\n\n### 1. Global Defaults\n\n- The `global` namespace serves as the foundational configuration applicable across all other namespaces unless overridden.\n- Includes general settings like URL and headers applicable for all API calls.\n- If no specific configurations are provided for other namespaces, the `global` defaults are used.\n\n### 2. Namespace-specific Configurations\n\n- Each namespace (`listen`, `manage`, `onprem`, `read`, `speak`) can have its specific configurations which override the `global` settings within their respective scopes.\n- Allows for detailed control over different parts of the application interacting with various Deepgram API endpoints.\n\n### 3. Transport Options\n\n- Configurations for both `fetch` and `websocket` can be specified under each namespace, allowing different transport mechanisms for different operations.\n- For example, the `fetch` configuration can have its own URL and proxy settings distinct from the `websocket`.\n- The generic interfaces define a structure for transport options which include a client (like a `fetch` or `WebSocket` instance) and associated options (like headers, URL, proxy settings).\n\nThis configuration system enables robust customization where defaults provide a foundation, but every aspect of the client's interaction with the API can be finely controlled and tailored to specific needs through namespace-specific settings. This enhances the maintainability and scalability of the application by localizing configurations to their relevant contexts.\n\n### 4. Examples\n\n#### Change the API url used for all SDK methods\n\nUseful for using different API environments (for e.g. beta).\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n// - or -\n// const { createClient } = require(\"@deepgram/sdk\");\n\nconst deepgram = createClient(DEEPGRAM_API_KEY, {\n  global: { fetch: { options: { url: \"https://api.beta.deepgram.com\" } } },\n});\n```\n\n#### Change the API url used for transcription only\n\nUseful for on-prem installations. Only affects requests to `/listen` endpoints.\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n// - or -\n// const { createClient } = require(\"@deepgram/sdk\");\n\nconst deepgram = createClient(DEEPGRAM_API_KEY, {\n  listen: { fetch: { options: { url: \"http://localhost:8080\" } } },\n});\n```\n\n#### Override fetch transmitter\n\nUseful for providing a custom http client.\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n// - or -\n// const { createClient } = require(\"@deepgram/sdk\");\n\nconst yourFetch = async () =\u003e {\n  return Response(\"...etc\");\n};\n\nconst deepgram = createClient(DEEPGRAM_API_KEY, {\n  global: { fetch: { client: yourFetch } },\n});\n```\n\n#### Proxy requests in the browser\n\nThis 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:\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n\nconst deepgram = createClient(\"proxy\", {\n  global: { fetch: { options: { proxy: { url: \"http://localhost:8080\" } } } },\n});\n```\n\n\u003e Important: You must pass `\"proxy\"` as your API key, and use the proxy to set the `Authorization` header to your Deepgram API key.\n\nYour proxy service should replace the Authorization header with `Authorization: token \u003cDEEPGRAM_API_KEY\u003e` and return results verbatim to the SDK.\n\nCheck out our example Node-based proxy here: [Deepgram Node Proxy](https://github.com/deepgram-devs/deepgram-node-proxy).\n\n#### Set custom headers for fetch\n\nUseful for many things.\n\n```js\nimport { createClient } from \"@deepgram/sdk\";\n\nconst deepgram = createClient(\"proxy\", {\n  global: { fetch: { options: { headers: { \"x-custom-header\": \"foo\" } } } },\n});\n```\n\n## Transcription (Synchronous)\n\n### Remote Files\n\n```js\nconst { result, error } = await deepgram.listen.prerecorded.transcribeUrl(\n  {\n    url: \"https://dpgr.am/spacewalk.wav\",\n  },\n  {\n    model: \"nova\",\n  }\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/pre-recorded).\n\n### Local Files\n\n```js\nconst { result, error } = await deepgram.listen.prerecorded.transcribeFile(\n  fs.createReadStream(\"./examples/spacewalk.wav\"),\n  {\n    model: \"nova\",\n  }\n);\n```\n\nor\n\n```js\nconst { result, error } = await deepgram.listen.prerecorded.transcribeFile(\n  fs.readFileSync(\"./examples/spacewalk.wav\"),\n  {\n    model: \"nova\",\n  }\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/pre-recorded).\n\n## Transcription (Asynchronous / Callbacks)\n\n### Remote Files\n\n```js\nimport { CallbackUrl } from \"@deepgram/sdk\";\n\nconst { result, error } = await deepgram.listen.prerecorded.transcribeUrlCallback(\n  {\n    url: \"https://dpgr.am/spacewalk.wav\",\n  },\n  new CallbackUrl(\"http://callback/endpoint\"),\n  {\n    model: \"nova\",\n  }\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/pre-recorded).\n\n### Local Files\n\n```js\nimport { CallbackUrl } from \"@deepgram/sdk\";\n\nconst { result, error } = await deepgram.listen.prerecorded.transcribeFileCallback(\n  fs.createReadStream(\"./examples/spacewalk.wav\"),\n  new CallbackUrl(\"http://callback/endpoint\"),\n  {\n    model: \"nova\",\n  }\n);\n```\n\nor\n\n```js\nimport { CallbackUrl } from \"@deepgram/sdk\";\n\nconst { result, error } = await deepgram.listen.prerecorded.transcribeFileCallback(\n  fs.readFileSync(\"./examples/spacewalk.wav\"),\n  new CallbackUrl(\"http://callback/endpoint\"),\n  {\n    model: \"nova\",\n  }\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/pre-recorded).\n\n## Transcription (Live / Streaming)\n\n### Live Audio\n\n```js\nconst dgConnection = deepgram.listen.live({ model: \"nova\" });\n\ndgConnection.on(LiveTranscriptionEvents.Open, () =\u003e {\n  dgConnection.on(LiveTranscriptionEvents.Transcript, (data) =\u003e {\n    console.log(data);\n  });\n\n  source.addListener(\"got-some-audio\", async (event) =\u003e {\n    dgConnection.send(event.raw_audio_data);\n  });\n});\n```\n\nTo see an example, [check out our Node.js example](https://github.com/deepgram-devs/node-live-example) or our [Browser example](https://github.com/deepgram-devs/js-live-example).\n\n[See our API reference for more info](https://developers.deepgram.com/reference/streaming).\n\n## Transcribing to captions\n\n```js\nimport { webvtt /* , srt */ } from \"@deepgram/captions\";\n\nconst { result, error } = await deepgram.listen.prerecorded.transcribeUrl(\n  {\n    url: \"https://dpgr.am/spacewalk.wav\",\n  },\n  {\n    model: \"nova\",\n  }\n);\n\nconst vttOutput = webvtt(result);\n// const srtOutput = srt(result);\n```\n\n[See our standalone captions library for more information](https://github.com/deepgram/deepgram-node-captions).\n\n## Text to Speech\n\n### Rest\n\n```js\nconst { result } = await deepgram.speak.request({ text }, { model: \"aura-asteria-en\" });\n```\n\n### Websocket\n\n```js\nconst dgConnection = deepgram.speak.live({ model: \"aura-asteria-en\" });\n\ndgConnection.on(LiveTTSEvents.Open, () =\u003e {\n  console.log(\"Connection opened\");\n\n  // Send text data for TTS synthesis\n  dgConnection.sendText(text);\n\n  // Send Flush message to the server after sending the text\n  dgConnection.flush();\n\n  dgConnection.on(LiveTTSEvents.Close, () =\u003e {\n    console.log(\"Connection closed\");\n  });\n});\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/text-to-speech-api).\n\n## Text Intelligence\n\n```js\nconst text = `The history of the phrase 'The quick brown fox jumps over the\nlazy dog'. The earliest known appearance of the phrase was in The Boston\nJournal. In an article titled \"Current Notes\" in the February 9, 1885, edition,\nthe phrase is mentioned as a good practice sentence for writing students: \"A\nfavorite copy set by writing teachers for their pupils is the following,\nbecause it contains every letter of the alphabet: 'A quick brown fox jumps over\nthe lazy dog.'\" Dozens of other newspapers published the phrase over the\nnext few months, all using the version of the sentence starting with \"A\" rather\nthan \"The\". The earliest known use of the phrase starting with \"The\" is from\nthe 1888 book Illustrative Shorthand by Linda Bronson.[3] The modern form\n(starting with \"The\") became more common even though it is slightly longer than\nthe original (starting with \"A\").`;\n\nconst { result, error } = await deepgram.read.analyzeText(\n  { text },\n  { language: \"en\", topics: true, sentiment: true }\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/analyze-text).\n\n## Projects\n\n### Get Projects\n\nReturns all projects accessible by the API key.\n\n```js\nconst { result, error } = await deepgram.manage.getProjects();\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-projects).\n\n### Get Project\n\nRetrieves a specific project based on the provided project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProject(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-project).\n\n### Update Project\n\nUpdate a project.\n\n```js\nconst { result, error } = await deepgram.manage.updateProject(projectId, options);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/update-project).\n\n## Delete Project\n\nDelete a project.\n\n```js\nconst { error } = await deepgram.manage.deleteProject(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/delete-project).\n\n## Keys\n\n### List Keys\n\nRetrieves all keys associated with the provided project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectKeys(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/list-keys).\n\n### Get Key\n\nRetrieves a specific key associated with the provided project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectKey(projectId, projectKeyId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-key).\n\n### Create Key\n\nCreates an API key with the provided scopes.\n\n```js\nconst { result, error } = await deepgram.manage.createProjectKey(projectId, options);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/create-key).\n\n### Delete Key\n\nDeletes a specific key associated with the provided project_id.\n\n```js\nconst { error } = await deepgram.manage.deleteProjectKey(projectId, projectKeyId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/delete-key).\n\n## Members\n\n### Get Members\n\nRetrieves account objects for all of the accounts in the specified project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectMembers(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-members).\n\n### Remove Member\n\nRemoves member account for specified member_id.\n\n```js\nconst { error } = await deepgram.manage.removeProjectMember(projectId, projectMemberId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/remove-member).\n\n## Scopes\n\n### Get Member Scopes\n\nRetrieves scopes of the specified member in the specified project.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectMemberScopes(projectId, projectMemberId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-member-scopes).\n\n### Update Scope\n\nUpdates the scope for the specified member in the specified project.\n\n```js\nconst { result, error } = await deepgram.manage.updateProjectMemberScope(\n  projectId,\n  projectMemberId,\n  options\n);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/update-scope).\n\n## Invitations\n\n### List Invites\n\nRetrieves all invitations associated with the provided project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectInvites(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/list-invites).\n\n### Send Invite\n\nSends an invitation to the provided email address.\n\n```js\nconst { result, error } = await deepgram.manage.sendProjectInvite(projectId, options);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/send-invites).\n\n### Delete Invite\n\nRemoves the specified invitation from the project.\n\n```js\nconst { error } = await deepgram.manage.deleteProjectInvite(projectId, email);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/delete-invite).\n\n### Leave Project\n\nRemoves the authenticated user from the project.\n\n```js\nconst { result, error } = await deepgram.manage.leaveProject(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/leave-project).\n\n## Usage\n\n### Get All Requests\n\nRetrieves all requests associated with the provided project_id based on the provided options.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectUsageRequest(projectId, requestId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-all-requests).\n\n### Get Request\n\nRetrieves a specific request associated with the provided project_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectUsageRequest(projectId, requestId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-request).\n\n### Summarize Usage\n\nRetrieves usage associated with the provided project_id based on the provided options.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectUsageSummary(projectId, options);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/summarize-usage).\n\n### Get Fields\n\nLists the features, models, tags, languages, and processing method used for requests in the specified project.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectUsageFields(projectId, options);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-fields).\n\n## Billing\n\n### Get All Balances\n\nRetrieves the list of balance info for the specified project.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectBalances(projectId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-all-balances).\n\n### Get Balance\n\nRetrieves the balance info for the specified project and balance_id.\n\n```js\nconst { result, error } = await deepgram.manage.getProjectBalance(projectId, balanceId);\n```\n\n[See our API reference for more info](https://developers.deepgram.com/reference/get-balance).\n\n## On-Prem APIs\n\n### List On-Prem credentials\n\n```js\nconst { result, error } = await deepgram.onprem.listCredentials(projectId);\n```\n\n### Get On-Prem credentials\n\n```js\nconst { result, error } = await deepgram.onprem.getCredentials(projectId, credentialId);\n```\n\n### Create On-Prem credentials\n\n```js\nconst { result, error } = await deepgram.onprem.createCredentials(projectId, options);\n```\n\n### Delete On-Prem credentials\n\n```js\nconst { result, error } = await deepgram.onprem.deleteCredentials(projectId, credentialId);\n```\n\n## Backwards Compatibility\n\nOlder SDK versions will receive Priority 1 (P1) bug support only. Security issues, both in our code and dependencies, are promptly addressed. Significant bugs without clear workarounds are also given priority attention.\n\nWe strictly follow semver, and will not introduce breaking changes to the publicly documented interfaces of the SDK. **Use internal and undocumented interfaces without pinning your version, at your own risk.**\n\n## Development and Contributing\n\nInterested in contributing? We ❤️ pull requests!\n\nTo make sure our community is safe for all, be sure to review and agree to our\n[Code of Conduct](./CODE_OF_CONDUCT.md). Then see the\n[Contribution](./CONTRIBUTING.md) guidelines for more information.\n\n### Debugging and making changes locally\n\nIf you want to make local changes to the SDK and run the [`examples/`](./examples/), you'll need to `npm run build` first, to ensure that your changes are included in the examples that are running.\n\n## Getting Help\n\nWe love to hear from you so if you have questions, comments or find a bug in the\nproject, let us know! You can either:\n\n- [Open an issue in this repository](https://github.com/deepgram/deepgram-node-sdk/issues/new)\n- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)\n- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepgram%2Fdeepgram-node-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepgram%2Fdeepgram-node-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepgram%2Fdeepgram-node-sdk/lists"}