API キーとは

API キーは、SoleAPI の公開 API を呼び出すための認証情報です。アカウント登録後に作成でき、SoleAPI の API キーは sk-sole- で始まります。

API キーの作成と削除は API キー管理 から行えます。

API キー作成時のオプションとルール

名前

後から識別、管理しやすいように、API キーの名前を自由に設定できます。

スケジューリンググループ

現在の API キーで呼び出せるモデルを決定します。グループを選択しない場合、デフォルトではプラットフォームが提供するすべての上流プロバイダーのモデルを呼び出せます。選択した場合は、そのグループに基づいて利用可能なモデルが決まります。

• モデルサービスが同じ互換プロトコルのエンドポイントに記載されていても、API キーのスケジューリンググループ、モデルの提供終了、またはアカウント権限により利用できない場合があります。
  デフォルトで何も選択しない場合、この API キーはプラットフォームが提供するすべての上流プロバイダーのモデルを呼び出せます。モデルカタログを参照してください。

ルーティング設定

SoleAPI では複数のルーティング設定を選択できます。

• スマートルーティング（デフォルト）：管理者がプロバイダーごとに高品質な供給元を指定し、それらを優先します。
• 最低コスト：同じモデルでも上流の供給元によって料金が異なる場合があります。より低料金の供給元を優先します。
• 最低レイテンシ：測定された応答時間が短い供給元を優先します。
• 最も安定：直近のリクエスト成功率が最も高い供給元を優先します。

利用上限

プラットフォームは API キーごとの利用額を Credits で集計します。キーごとに個別の上限を設定でき、上限に達するとリクエストは HTTP 402 で拒否されます。
0 に設定すると無制限になります。

有効期限

API キーに有効期限を設定できます。期限を過ぎると自動的に無効化されるため、一時的な連携や第三者への引き渡しに適しています。
空欄の場合、有効期限は設定されず、無期限で有効です。

アクセス元 IP 許可リスト

API キーにアクセス元 IP の許可リストを設定できます。許可された IP だけがそのキーを使用でき、それ以外からのリクエストは HTTP 403 で拒否されます。固定 IP の端末では、キー漏えい後の不正利用リスクを軽減できます。
空欄の場合、すべての IP アドレスからのアクセスを許可します。

有効化／無効化

過去の利用履歴を削除せず、いつでもキーを無効化できます。