Using Deepgram Management API (JavaScript / TypeScript SDK)
Administrative REST endpoints under /v1/projects, /v1/models, and related project subresources.
When to use this product
- Projects: list, get, update, delete, leave.
- Keys: list, get, create, delete API keys.
- Members + invites: inspect members, update scopes, create/delete invites.
- Usage + billing: inspect requests, usage, usage breakdown, balances, purchases, billing breakdown.
- Models: list global models and project-scoped models.
- Agent think models: discover available model providers for Voice Agent
think settings.
Use a different skill when:
- You want to run a live websocket agent session →
deepgram-js-voice-agent.
- You want transcription or synthesis calls rather than project/admin APIs → product-specific skills.
Authentication
require("dotenv").config();
const { DeepgramClient } = require("@deepgram/sdk");
const deepgramClient = new DeepgramClient({
apiKey: process.env.DEEPGRAM_API_KEY,
});
Most examples also rely on process.env.DEEPGRAM_PROJECT_ID for project-scoped calls.
Quick start — projects + models
From examples/13-management-projects.ts, examples/19-management-models.ts, and examples/32-management-project-models.ts:
const projectId = process.env.DEEPGRAM_PROJECT_ID;
const projects = await deepgramClient.manage.v1.projects.list();
console.log("Projects:", JSON.stringify(projects, null, 2));
const project = await deepgramClient.manage.v1.projects.get(projects.projects[0].project_id);
await deepgramClient.manage.v1.projects.update(project.project_id, {
name: "Naomi's Sandbox",
});
const models = await deepgramClient.manage.v1.models.list();
const projectModels = await deepgramClient.manage.v1.projects.models.list(
projectId,
{ include_outdated: false },
);
Quick start — keys / members / invites / usage / billing
Based on examples/14-18:
const projectId = process.env.DEEPGRAM_PROJECT_ID;
await deepgramClient.manage.v1.projects.keys.list(projectId);
await deepgramClient.manage.v1.projects.members.list(projectId);
await deepgramClient.manage.v1.projects.members.invites.create(projectId, {
email: "user@example.com",
scope: "member",
});
await deepgramClient.manage.v1.projects.requests.list(projectId, {});
await deepgramClient.manage.v1.projects.usage.get(projectId, {});
await deepgramClient.manage.v1.projects.billing.balances.list(projectId);
Think-model discovery for Voice Agent:
await deepgramClient.agent.v1.settings.think.models.list();
Key parameters / API surface
- Projects:
client.manage.v1.projects.list/get/update/delete/leave.
- Keys:
client.manage.v1.projects.keys.list/create/get/delete.
- Members:
client.manage.v1.projects.members.list/delete and members.scopes.list/update.
- Invites:
client.manage.v1.projects.members.invites.list/create/delete.
- Requests + usage:
projects.requests.list/get, projects.usage.get, projects.usage.breakdown.list, projects.usage.fields.list.
- Billing:
projects.billing.balances.*, projects.billing.breakdown.list, projects.billing.fields.list, projects.billing.purchases.list.
- Models:
client.manage.v1.models.list/get and client.manage.v1.projects.models.list/get.
Limitations
The current JS SDK does not expose persisted Voice Agent configuration CRUD endpoints. The repo surfaces client.agent.v1.settings.think.models.list() for discovery, but not voice_agent.configurations.*-style helpers.
API reference (layered)
- In-repo reference:
reference.md → Manage V1 Models, Manage V1 Projects, Manage V1 Projects Keys, Members, Models, Requests, Usage, Billing *, plus Agent V1 Settings Think Models.
- Canonical OpenAPI (REST): https://developers.deepgram.com/openapi.yaml
- Canonical AsyncAPI (WSS): https://developers.deepgram.com/asyncapi.yaml
- Context7: library ID
/llmstxt/developers_deepgram_llms_txt
- Product docs:
Gotchas
- Namespace depth matters. Most admin calls live under
client.manage.v1.projects.*, not on the root client.
- Project-scoped and global models differ.
/v1/models returns public models; /v1/projects/{id}/models can include private/custom access.
projects.usage.get(...) is marked deprecated in source. Prefer projects.usage.breakdown.list(...) for richer reporting.
- Destructive operations are real.
delete, leave, member removal, and key deletion are not safe example calls.
- Management APIs are not the same as regional STT routing.
examples/33-configuration-eu-endpoint.ts explicitly notes management stays on the default US endpoint.
- Returned IDs can be nested. Example key lookup uses
keys.api_keys[0].api_key.api_key_id; inspect real response shape before hard-coding paths.
- No persisted agent config helpers are present. If you need Voice Agent configuration CRUD, use raw HTTP for now.
Example files in this repo
examples/13-management-projects.ts
examples/14-management-keys.ts
examples/15-management-members.ts
examples/16-management-invites.ts
examples/17-management-usage.ts
examples/18-management-billing.ts
examples/19-management-models.ts
examples/29-management-usage-breakdown.ts
examples/30-management-billing-detailed.ts
examples/31-management-member-permissions.ts
examples/32-management-project-models.ts
Central product skills
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
npx skills add deepgram/skills
This SDK ships language-idiomatic code skills; deepgram/skills ships cross-language product knowledge (see api, docs, recipes, examples, starters, setup-mcp).
1---2name: deepgram-js-management-api3description: Use when writing or reviewing JavaScript/TypeScript in this repo that calls Deepgram Management APIs for projects, API keys, members, invites, requests, usage, billing, models, and agent think-model discovery. Covers `client.manage.v1.*` plus `client.agent.v1.settings.think.models.list()`. Use `deepgram-js-voice-agent` when you want to run an agent live rather than administer projects or inspect models. Triggers include "management API", "list projects", "API keys", "members", "invites", "usage stats", "billing", "list models", and "manage.v1".4metadata:5 source: https://skillmd.com/skills/deepgram/deepgram-js-management-api6---78# Using Deepgram Management API (JavaScript / TypeScript SDK)910Administrative REST endpoints under `/v1/projects`, `/v1/models`, and related project subresources.1112## When to use this product1314- **Projects**: list, get, update, delete, leave.15- **Keys**: list, get, create, delete API keys.16- **Members + invites**: inspect members, update scopes, create/delete invites.17- **Usage + billing**: inspect requests, usage, usage breakdown, balances, purchases, billing breakdown.18- **Models**: list global models and project-scoped models.19- **Agent think models**: discover available model providers for Voice Agent `think` settings.2021**Use a different skill when:**22- You want to run a live websocket agent session → `deepgram-js-voice-agent`.23- You want transcription or synthesis calls rather than project/admin APIs → product-specific skills.2425## Authentication2627```js28require("dotenv").config();2930const { DeepgramClient } = require("@deepgram/sdk");3132const deepgramClient = new DeepgramClient({33 apiKey: process.env.DEEPGRAM_API_KEY,34});35```3637Most examples also rely on `process.env.DEEPGRAM_PROJECT_ID` for project-scoped calls.3839## Quick start — projects + models4041From `examples/13-management-projects.ts`, `examples/19-management-models.ts`, and `examples/32-management-project-models.ts`:4243```js44const projectId = process.env.DEEPGRAM_PROJECT_ID;4546const projects = await deepgramClient.manage.v1.projects.list();47console.log("Projects:", JSON.stringify(projects, null, 2));4849const project = await deepgramClient.manage.v1.projects.get(projects.projects[0].project_id);50await deepgramClient.manage.v1.projects.update(project.project_id, {51 name: "Naomi's Sandbox",52});5354const models = await deepgramClient.manage.v1.models.list();55const projectModels = await deepgramClient.manage.v1.projects.models.list(56 projectId,57 { include_outdated: false },58);59```6061## Quick start — keys / members / invites / usage / billing6263Based on `examples/14-18`:6465```js66const projectId = process.env.DEEPGRAM_PROJECT_ID;6768await deepgramClient.manage.v1.projects.keys.list(projectId);69await deepgramClient.manage.v1.projects.members.list(projectId);70await deepgramClient.manage.v1.projects.members.invites.create(projectId, {71 email: "user@example.com",72 scope: "member",73});74await deepgramClient.manage.v1.projects.requests.list(projectId, {});75await deepgramClient.manage.v1.projects.usage.get(projectId, {});76await deepgramClient.manage.v1.projects.billing.balances.list(projectId);77```7879Think-model discovery for Voice Agent:8081```js82await deepgramClient.agent.v1.settings.think.models.list();83```8485## Key parameters / API surface8687- Projects: `client.manage.v1.projects.list/get/update/delete/leave`.88- Keys: `client.manage.v1.projects.keys.list/create/get/delete`.89- Members: `client.manage.v1.projects.members.list/delete` and `members.scopes.list/update`.90- Invites: `client.manage.v1.projects.members.invites.list/create/delete`.91- Requests + usage: `projects.requests.list/get`, `projects.usage.get`, `projects.usage.breakdown.list`, `projects.usage.fields.list`.92- Billing: `projects.billing.balances.*`, `projects.billing.breakdown.list`, `projects.billing.fields.list`, `projects.billing.purchases.list`.93- Models: `client.manage.v1.models.list/get` and `client.manage.v1.projects.models.list/get`.9495## Limitations9697The current JS SDK does **not** expose persisted Voice Agent configuration CRUD endpoints. The repo surfaces `client.agent.v1.settings.think.models.list()` for discovery, but not `voice_agent.configurations.*`-style helpers.9899## API reference (layered)1001011. **In-repo reference**: `reference.md` → `Manage V1 Models`, `Manage V1 Projects`, `Manage V1 Projects Keys`, `Members`, `Models`, `Requests`, `Usage`, `Billing *`, plus `Agent V1 Settings Think Models`.1022. **Canonical OpenAPI (REST)**: https://developers.deepgram.com/openapi.yaml1033. **Canonical AsyncAPI (WSS)**: https://developers.deepgram.com/asyncapi.yaml1044. **Context7**: library ID `/llmstxt/developers_deepgram_llms_txt`1055. **Product docs**:106 - https://developers.deepgram.com/reference/manage/projects/list107 - https://developers.deepgram.com/reference/manage/models/list108 - https://developers.deepgram.com/reference/voice-agent/agent-configurations/list-agent-configurations109 - https://developers.deepgram.com/reference/voice-agent/agent-configurations/create-agent-configuration110 - https://developers.deepgram.com/reference/voice-agent/think-models111112## Gotchas1131141. **Namespace depth matters.** Most admin calls live under `client.manage.v1.projects.*`, not on the root client.1152. **Project-scoped and global models differ.** `/v1/models` returns public models; `/v1/projects/{id}/models` can include private/custom access.1163. **`projects.usage.get(...)` is marked deprecated in source.** Prefer `projects.usage.breakdown.list(...)` for richer reporting.1174. **Destructive operations are real.** `delete`, `leave`, member removal, and key deletion are not safe example calls.1185. **Management APIs are not the same as regional STT routing.** `examples/33-configuration-eu-endpoint.ts` explicitly notes management stays on the default US endpoint.1196. **Returned IDs can be nested.** Example key lookup uses `keys.api_keys[0].api_key.api_key_id`; inspect real response shape before hard-coding paths.1207. **No persisted agent config helpers are present.** If you need Voice Agent configuration CRUD, use raw HTTP for now.121122## Example files in this repo123124- `examples/13-management-projects.ts`125- `examples/14-management-keys.ts`126- `examples/15-management-members.ts`127- `examples/16-management-invites.ts`128- `examples/17-management-usage.ts`129- `examples/18-management-billing.ts`130- `examples/19-management-models.ts`131- `examples/29-management-usage-breakdown.ts`132- `examples/30-management-billing-detailed.ts`133- `examples/31-management-member-permissions.ts`134- `examples/32-management-project-models.ts`135136## Central product skills137138For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:139140```bash141npx skills add deepgram/skills142```143144This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).