Labsco
deepgram logo

deepgram-js-management-api

266

by deepgram · part of deepgram/deepgram-js-sdk

Use when writing or reviewing JavaScript/TypeScript in this repo that calls Deepgram Management APIs for projects, API keys, members, invites, requests, usage,…

🔥🔥🔥✓ VerifiedFreeQuick setup
🧰 Not standalone. This skill ships with deepgram/deepgram-js-sdk and only works together with that tool — install the tool first, then add this skill.

This is the playbook your agent receives when the skill activates — you don't need to read it to use the skill, but it's here to audit before installing.


name: deepgram-js-management-api description: 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".

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.

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.

API reference (layered)

  1. In-repo reference: reference.mdManage V1 Models, Manage V1 Projects, Manage V1 Projects Keys, Members, Models, Requests, Usage, Billing *, plus Agent V1 Settings Think Models.
  2. Canonical OpenAPI (REST): https://developers.deepgram.com/openapi.yaml
  3. Canonical AsyncAPI (WSS): https://developers.deepgram.com/asyncapi.yaml
  4. Context7: library ID /llmstxt/developers_deepgram_llms_txt
  5. Product docs:

Gotchas

  1. Namespace depth matters. Most admin calls live under client.manage.v1.projects.*, not on the root client.
  2. Project-scoped and global models differ. /v1/models returns public models; /v1/projects/{id}/models can include private/custom access.
  3. projects.usage.get(...) is marked deprecated in source. Prefer projects.usage.breakdown.list(...) for richer reporting.
  4. Destructive operations are real. delete, leave, member removal, and key deletion are not safe example calls.
  5. 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.
  6. 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.
  7. 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).