deepgram-js-management-api

Deepgram Management API（JavaScript / TypeScript SDK）の使用

/v1/projects、/v1/models、および関連するプロジェクトのサブリソースに対応する管理用 REST エンドポイントです。

この製品を使用する場合

• プロジェクト：一覧表示、取得、更新、削除、退出。
• キー：API キーの一覧表示、取得、作成、削除。
• メンバー + 招待：メンバーの確認、スコープの更新、招待の作成／削除。
• 使用状況 + 請求：リクエスト、使用状況、使用状況の内訳、残高、購入、請求の内訳を確認。
• モデル：グローバルモデルとプロジェクトスコープのモデルを一覧表示。
• Agent think モデル：Voice Agent の think 設定で使用できるモデルプロバイダーを確認。

次の場合は、別のスキルを使用してください：

• ライブの WebSocket エージェントセッションを実行する場合 → deepgram-js-voice-agent。
• プロジェクト／管理 API ではなく、文字起こしや音声合成の呼び出しを行う場合 → 製品固有のスキル。

認証

require("dotenv").config();

const { DeepgramClient } = require("@deepgram/sdk");

const deepgramClient = new DeepgramClient({
  apiKey: process.env.DEEPGRAM_API_KEY,
});

ほとんどの例では、プロジェクトスコープの呼び出しに process.env.DEEPGRAM_PROJECT_ID も使用します。

クイックスタート — プロジェクト + モデル

examples/13-management-projects.ts、examples/19-management-models.ts、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 },
);

クイックスタート — キー／メンバー／招待／使用状況／請求

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: "[email protected]",
  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);

Voice Agent の think モデルの確認：

await deepgramClient.agent.v1.settings.think.models.list();

主なパラメーター／API サーフェス

• プロジェクト：client.manage.v1.projects.list/get/update/delete/leave。
• キー：client.manage.v1.projects.keys.list/create/get/delete。
• メンバー：client.manage.v1.projects.members.list/delete および members.scopes.list/update。
• 招待：client.manage.v1.projects.members.invites.list/create/delete。
• リクエスト + 使用状況：projects.requests.list/get、projects.usage.get、projects.usage.breakdown.list、projects.usage.fields.list。
• 請求：projects.billing.balances.*、projects.billing.breakdown.list、projects.billing.fields.list、projects.billing.purchases.list。
• モデル：client.manage.v1.models.list/get および client.manage.v1.projects.models.list/get。

制限事項

現在の JS SDK は、永続化された Voice Agent 設定の CRUD エンドポイントを公開していません。リポジトリでは確認用に client.agent.v1.settings.think.models.list() を公開していますが、voice_agent.configurations.* のようなヘルパーはありません。

API リファレンス（階層別）

1. リポジトリ内のリファレンス：reference.md → Manage V1 Models、Manage V1 Projects、Manage V1 Projects Keys、Members、Models、Requests、Usage、Billing *、および Agent V1 Settings Think Models。
2. 標準 OpenAPI（REST）：https://developers.deepgram.com/openapi.yaml
3. 標準 AsyncAPI（WSS）：https://developers.deepgram.com/asyncapi.yaml
4. Context7：ライブラリ ID /llmstxt/developers_deepgram_llms_txt
5. 製品ドキュメント：
   • https://developers.deepgram.com/reference/manage/projects/list
   • https://developers.deepgram.com/reference/manage/models/list
   • https://developers.deepgram.com/reference/voice-agent/agent-configurations/list-agent-configurations
   • https://developers.deepgram.com/reference/voice-agent/agent-configurations/create-agent-configuration
   • https://developers.deepgram.com/reference/voice-agent/think-models

注意点

1. 名前空間の深さが重要です。 管理関連の呼び出しのほとんどは、ルートクライアントではなく client.manage.v1.projects.* の下にあります。
2. プロジェクトスコープのモデルとグローバルモデルは異なります。 /v1/models は公開モデルを返しますが、/v1/projects/{id}/models にはプライベートなモデルやカスタムアクセスのモデルが含まれる場合があります。
3. projects.usage.get(...) はソース内で非推奨とされています。 より詳細なレポートには projects.usage.breakdown.list(...) を使用してください。
4. 破壊的操作は実際に実行されます。 delete、leave、メンバーの削除、キーの削除は、安全なサンプル呼び出しではありません。
5. 管理 API は、リージョン別の STT ルーティングとは別です。 examples/33-configuration-eu-endpoint.ts には、管理機能はデフォルトの米国エンドポイントを使用し続けると明記されています。
6. 返される ID は入れ子になっている場合があります。 キー検索の例では keys.api_keys[0].api_key.api_key_id を使用しています。パスをハードコードする前に、実際のレスポンス構造を確認してください。
7. 永続化されたエージェント設定用のヘルパーはありません。 Voice Agent の設定を CRUD する必要がある場合は、現時点では生の HTTP を使用してください。

このリポジトリ内のサンプルファイル

• 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

中核となる製品スキル

言語をまたいで Deepgram 製品の知識を活用するには、統合 API リファレンス、ドキュメント検索ツール、目的別の実行可能なレシピ、サードパーティ連携のサンプル、MCP のセットアップが含まれる中核スキルをインストールしてください。

npx skills add deepgram/skills

この SDK には各言語の慣習に沿ったコードスキルが含まれています。deepgram/skills には言語をまたいで使える製品知識が含まれています（api、docs、recipes、examples、starters、setup-mcp を参照してください）。