Skip to main content

概要

Management API を使うと、通常の推論用 API Key を使わずに、組織残高の取得、組織 API Key の管理、キー単位の使用量・請求情報の取得ができます。 管理トークンはダッシュボードの 設定 ページで発行・ローテーションできます。
管理トークンは推論用 API Key とは異なります。mt-.../v1/management/* 用、sk-.../v1/responses などの推論エンドポイント用です。

利用できるエンドポイント

利用フィルタ

GET /v1/management/api-keys/{keyId}/usage では以下の query パラメータを利用できます。 startDateendDate を同時に指定する場合、startDateendDate 以下である必要があります。

API Key リクエスト本文

POST /v1/management/api-keys

PATCH /v1/management/api-keys/

PATCH リクエストでは少なくとも 1 つのフィールドを指定する必要があります。

金額フィールド

  • Management API の金額リクエストおよびレスポンスフィールドは USD のみをサポートします。
  • limitCurrency の既定値は USD です。CNY を送信すると 400 currency_retired が返されます。

レポートの意味

  • model は、呼び出し元が要求した公開 model を指します。
  • modelVendor は、隠れた互換ルートではなく、公開 model vendor を指します。
  • scene は、endpoint または task type から導出される公開リクエストシーンです。
レスポンスには公開可能な Billing / Reporting 項目のみが含まれ、非公開のプロバイダー詳細は公開されません。
  • /usage の各明細には、基になるリクエストの精算完了後に billing_transaction_id が含まれる場合があります。リクエスト単位の照合には request_id + billing_transaction_id を使用してください。

請求のページネーションに関する注意

/usage はページネーション対応です。/billing は現在、集計済み請求内訳を返すエンドポイントであり、page / limit 型のページネーション情報は返しません。行レベルの明細が必要な場合は /usage を利用してください。

クイック例

まずは現在の管理トークンで組織残高を確認します。
次に、同じ管理トークンで参照可能な API Keys を一覧します。

次のステップ