ガイド

クイックスタート

RunAPI管理キーを使用して、標準APIキーとガードレールを作成・管理します。

プラットフォーム管理を使用すると、アカウント管理者はダッシュボードを都度操作することなく、標準 API キーとガードレールの作成・確認・更新・失効を行えます。

管理キーを作成する

認証ガイドに従ってサインインし、管理キーページを開いて管理キーを作成します。標準のアプリケーションキーとは別に保管してください。Platform Managementエンドポイントにのみ、Bearerトークンとして送信してください。

HTTP

Authorization: Bearer YOUR_MANAGEMENT_KEY

標準 API キーはキーまたはガードレール管理エンドポイントを呼び出すことができません。有効な管理キーでも、所有者が必要なアカウントロールを持っていない場合は 403 Forbidden を受け取ることがあります。

標準APIキーの一覧取得

管理キーのアカウントから参照可能なキーを確認するには、GET /api/v1/keys を使用してください：

SHELL

curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

後続の取得・更新・失効・ガードレール割り当てリクエストには、返却された公開識別子を使用してください。キー名やマスクされたトークンからアクセス権を推測しないでください。

キーの作成とローテーション

POST /api/v1/keysでアプリケーションキーを作成します。完全なシークレットは作成レスポンスでのみ返されるため、そのレスポンスを破棄する前にシークレットマネージャーに保存してください。ローテーションでは、代替キーを作成してアプリケーションにデプロイし、トラフィックを確認してから古いキーを無効化します。

SHELL

curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows は 1h、1d、7d のローリング支出上限の任意の組み合わせを受け付けます。設定されたウィンドウのいずれかが上限に達した場合、そのキーを使用した呼び出しは、使用量がウィンドウから外れるまで 429 Too Many Requests を返します。キーを更新する際にすべてのローリング上限をクリアするには、空のオブジェクトを送信してください。

ガードレールを適用

Guardrail は、モデル、プロバイダー、および支出制御のための再利用可能なアカウントポリシーです。/api/v1/guardrails を通じてポリシーを管理し、/api/v1/guardrail_assignments を使用して添付または削除します。拒否されたアサインメントは、Guardrail なしで暗黙的に続行するのではなく、ポリシーまたは所有権の失敗として扱ってください。

管理エラーの処理

401 Unauthorized は、認証情報が欠落している、不正な形式である、失効している、または無効であることを意味します。
403 Forbidden は、認証情報クラスまたはアカウントロールではその操作を実行できないことを意味します。
404 Not Found は、リクエストされたリソースが認証済みアカウントから参照できないことを意味します。
422 Unprocessable Content は、送信された1つ以上の値がリソースのルールに違反していることを意味します。