Skip to main content

概要

この endpoint では、既存 API Key の名前、利用上限、許可モデル、有効期限、状態を更新できます。

リクエストボディ

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

補足

  • 金額フィールドは USD のみをサポートします。CNY 入力は廃止されており、400 currency_retired が返されます。
  • Management API v1 ではハード削除は意図的にサポートしていません。
  • revoked は通常終端状態として扱われます。再度キーが必要な場合は、新しいキーを作成するのが一般的です。

リクエスト / レスポンス

正確な schema とレスポンス項目は、上部のインタラクティブな OpenAPI パネルを参照してください。

レスポンス例

重要なフィールド

string
後続の Management API 呼び出しで使用する API キー識別子。
string
API キーの表示名。
string
表示およびサポート用の機密ではないキープレフィックス。
string
activeinactiverevoked のいずれか。
number | null
表示用に JSON 数値で返される USD の利用上限。null は無制限を意味します。
string | null
10 進文字列で返される USD の正確な利用上限。null は無制限を意味します。
number
表示用に JSON 数値で返される USD の累積利用額。
string
10 進文字列で返される USD の正確な累積利用額。
string[]
キー単位のモデル許可リスト。空の配列は、キー単位の追加モデル制限がないことを意味します。
string | null
キーの有効期限を示す ISO タイムスタンプ。期限なしの場合は null
string | null
最終利用時刻の ISO タイムスタンプ。未使用の場合は null
string
作成時刻の ISO タイムスタンプ。