ガイド更新日:
現在の公式 v3 文書に基づく実装です。実アカウントのキー作成、権限、範囲、金額、操作手順は未検証です。自動テストや公開は実残高の照合ではありません。
- 必要な認証情報
- HeyGen API キー
- 監視通貨
- USD · 米ドル
- 監視の対象
- API プリペイド残高 · USD
- 固定 GET https://api.heygen.com/v3/users/me で billing_type=wallet と wallet.currency=usd を確認し、wallet.remaining_balance をそのまま使用します(scope=account)。remaining_balance=42.5 は $42.5 です。60 や 100 で割らず、使用額を再控除しません。
キーを共有せずに残高を確認するには?
- 公式 API プラットフォームで課金アカウント/ワークスペースを確認します。
- 請求欄の USD プリペイド残高を読みます。Web プラン、企業 Credits、従量課金上限とは別です。
- 通貨と時刻を記録します。手動確認ではキーの共有は不要で、入金はアカウント所有者が判断します。
HeyGen を Quota Monitor に接続する
API アカウントとウォレットを確認
下の HeyGen API プラットフォームに、実際に API 料金を支払うアカウントでログインします。チームの場合は業務用ワークスペースを選び、請求・残高欄で通貨、金額、時刻を記録してください。
確認:Web サブスクリプションの Credits ではなく USD プリペイドです。企業 Credits や従量課金しかない場合は手動確認に留め、監視テストのためにプラン変更や入金をしないでください。
専用 API キーを作成
下の API keys を開き、同じアカウント/ワークスペースであることを確認します。作成機能から監視用キーを新規作成し、名前欄があれば Quota Monitor、有効期限欄があれば適切な期限を設定します。
確認:本番アプリのキーを置き換えず、別のキーを作成しました。作成できない場合は管理者に相談し、ログイン Cookie で代用しないでください。
account:read だけを許可
キーの権限設定でカスタム権限を選び、account:read のみを有効にして保存します。対応先は GET /v3/users/me です。生成、書き込み、全権限 *:* は許可しません。表示名が変わっても保存後の scope を確認してください。
確認:すべての読み取りを許す *:read ではなく account:read です。本設定用の貼り付け可能な IAM ポリシーは文書化されていないため、架空の JSON は提供しません。限定できない場合は手動確認と HeyGen サポートを利用します。
秘密値を安全に保存
パスワード管理ツールに保存し、X-Api-Key:、Bearer、引用符、空白、伏字を含めず秘密値だけをコピーします。保存済み権限を確認し、必要なら自身の安全なツールで GET /v3/api_keys/self の scope_mode=custom と scopes を確認できます。
確認:キーをチャット、画像、問い合わせ、URL、MCP 引数に載せていません。当サイトは権限確認 API を呼びません。account:read でも個人情報を読めるため厳重に保管してください。
Quota Monitor のプロジェクトに追加
対象プロジェクトで接続を追加し、HeyGen(USD プリペイドウォレット)を選択します。識別しやすい名前を付け、伏字入力欄にキーを貼り付けて保存します。MCP では安全な入力リンクを使い、agent にキーを送らないでください。
確認:正しいプロジェクトと USD が選ばれています。カスタム URL、上流プロジェクト ID、キー ID は入力しません。同じ接続を別プロジェクトでも使っても別口座にはなりません。
初回同期の成功を確認
自動同期を待つか、一度だけ更新します。成功すると API ウォレット残高と新しい照会時刻が表示されます。クールダウンが出た場合は待ち、連打しないでください。
確認:金額だけでなく状態と時刻も確認します。失敗時には古い値が残ります。null、欠落、権限不足、非対応の課金方式はゼロドルに置き換えません。
同じアカウントと単位で照合
同じ HeyGen API アカウントに戻り、USD プリペイド残高と比較します。remaining_balance=42.5 は $42.5 です。旧 quota の秒数ではなく、60 で割ったり消費上限や auto_reload 閾値と比較したりしません。
確認:REST/MCP の heygenBalance.balance がカードと一致し、billingType=wallet、scope=account です。両方の時刻を記録し、処理中の使用分があれば後で再照会します。差額を推計で補完しません。
資金管理・ローテーション・実機確認
残高が少ない場合はカードから公式プラットフォームを開き、対象を確認して支払権限のある人が入金を判断します。当サイトは入金や自動チャージの変更をしません。交換時は別の account:read キーで接続を更新し、同期成功後に旧監視キーだけを失効させます。
確認:プロジェクトの関連付け解除や接続削除では公式キーは失効しません。実アカウントで操作と金額を検証し、報告にはマスク済みエラー、時刻、差額だけを含めてください。キー、個人情報、完全な応答は送らないでください。
Quota Monitor が取得する HeyGen のデータ範囲
- API キーの USD プリペイドウォレットのみ対応。Enterprise の currency=credits、OAuth の subscription、usage_based 課金は対象外で、ドルに換算しません。
- キーが上流アカウント/ワークスペースを選択します。組織、プロジェクト、キーの追加フィルターはありません。同じ口座を複数の Quota Monitor プロジェクトで参照しても合算しないでください。
- 正確な残高と課金方式だけを保存します。ユーザー名、メール、氏名、自動チャージ設定は破棄します。REST/MCP の heygenBalance.balance とカードは同じ金額です。
- キャッシュなしの GET を一回だけ行い、リダイレクトは禁止します。生成、キー管理、支払い、auto_reload の変更は行いません。自動チャージ閾値は残高ではありません。
- null や欠落は不明でありゼロではありません。失敗時は前回金額と時刻を保持し、ゼロや負数もそのまま表示します。照会時刻は決済確定を意味せず、正の残高もモデル実行を保証しません。
- ダッシュボードには、最後に成功した照会結果を表示します。手動更新で再照会できますが、プロバイダーの請求反映の遅延は解消できません。照会が失敗したあとに残る古い残高は、新しい結果ではありません。
HeyGen のよくある質問とトラブルシューティング
- 401:キーが拒否される?
- platform.heygen.com/api-keys で作成した完全な有効キーか確認します。X-Api-Key:、Bearer、空白を除き、OAuth やブラウザーのセッションを使わないでください。
- 403:insufficient_api_key_scope?
- 同じアカウントで account:read が保存されているか確認します。生成や管理者権限を追加する必要はありません。限定できなければ HeyGen サポートまたは手動確認を利用してください。
- 課金方式・通貨が非対応?
- billing_type=wallet と currency=usd のみ対応します。Enterprise currency=credits、subscription、usage_based はドル財布として扱いません。手動で確認し、プラン変更や保護解除は不要です。
- null・欠落・invalid_response?
- null は不明で、ゼロではありません。旧 quota へ回退せず前回成功値を保持します。マスクしたエラーと時刻を記録し、公式状態を確認して後で再試行してください。完全なプロフィール応答は送らないでください。
- 404・429・タイムアウト?
- 404 は端点の可用性変更の可能性があります。429 は制限解除を待ち、タイムアウトは後で再試行します。ミラー、Cookie、権限拡大を使わず、表示時刻が古い成功結果か確認してください。
- 残高が重複する、Web Credits と違う?
- 複数プロジェクトが同じ上流口座を参照する場合は合算しません。API の USD、Web プラン、企業 Credits、自動チャージ閾値、従量課金上限は異なります。同じアカウントと近い時刻で比較してください。
HeyGen の公式資料
- 公式資料 · developers.heygen.com/reference/get-current-user(新しいタブで開きます)
- 公式資料 · developers.heygen.com/user-profile(新しいタブで開きます)
- 公式資料 · developers.heygen.com/docs/api-key(新しいタブで開きます)
- 公式資料 · developers.heygen.com/docs/api-key-permissions(新しいタブで開きます)
- 公式資料 · developers.heygen.com/reference/get-current-api-key(新しいタブで開きます)
Quota Monitor が作成したガイドで、プロバイダーの公式チュートリアルではありません。画面や権限は変更される場合があるため、公式ページも確認してください。検証済みの範囲は、ここに記載した内容に限られます。