メインコンテンツへスキップ
コンソールのトークン画面でできる操作を、自分のコードから実行できます。取引先ごとの上限付きキーの自動発行や、案件終了時のキーの一括無効化に向いています。これらのキーでの呼び出しは、お客様の残高から課金されます。
AccessTokenはアカウントのすべてを操作できます。サーバー内にとどめてください。
  • ブラウザやアプリに含めたり、取引先に渡したりしないでください。取引先に渡すのは、こちらで作成したAPIキーだけです。
  • 無効なトークンでもHTTP 200と success: false が返ります。呼び出しのたびに success を確認してください。

エンドポイント

一覧と検索は1ページ10件で、p は0から始まります。これらの結果の key はマスクされています。モデルの呼び出しに使う完全なキーは、表示用のエンドポイントで取得してください。

新しいキーのフィールド

billing_type によって、そのキーで呼び出せるモデルが決まります。従量課金のキーは従量課金のモデルだけ、回数課金のキーは回数課金のモデルだけ、従量優先のキーは両方を呼び出せます。3つの方式は課金と料金で説明しています。

キーの作成と表示

次のスクリプトは、上限5米ドル、有効期限30日、許可モデル2つのキーを作成し、完全なキーを表示します。requests が必要です(python -m pip install requests)。
表示されたキーは、sk- の接頭辞の有無にかかわらず、モデルのAPIキーとして使えます(Authorization: Bearer <key>)。取引先に渡す前に、シークレット管理ツールに保存してください。表示用のエンドポイントは厳しくレート制限されているため、繰り返し呼び出さないでください。

更新・無効化・削除

更新ではキーのオブジェクト全体が置き換わります。GET /api/token/{id} で取得し、必要なフィールドだけ変更して、オブジェクト全体を PUT で送り返してください。一部のフィールドだけを送ると、ほかのフィールドが初期値に戻ることがあります。
変更はすぐに反映されます。
  • 無効化または削除したキーでモデルを呼び出すと、HTTP 401と Invalid token. が返ります。
  • 許可リストにないモデルを呼び出すと、そのトークンではこのモデルを使えない旨のメッセージとともに、HTTP 403が返ります。

エラー

よくある質問

取引先のキーは、誰の残高から課金されますか?

お客様の残高です。各キーの remain_quota に上限を設定してください。キーが上限に達すると使えなくなり、お客様の残りの残高から引き続き差し引かれることはありません。

キーごとの使用量はどう確認しますか?

一覧と詳細のレスポンスにある used_quota が、そのキーの累計使用量です。期間やモデルごとに分けて見るには、token_name を指定してログ照会APIを使ってください。

model_limits を設定したのに無視されるのはなぜですか?

モデルの許可リストは models からのみ読み取られます。許可するモデルIDをカンマ区切りの文字列にして、models に指定してください。

関連ドキュメント