API Key の作成

組織のオーナーが、組織内の Agent または Workflow の API Key を作成できます。

このエンドポイントを使用して、指定した Agent または Workflow に新しい API Key を発行し、その Key にバージョン管理権限を付与するかどうかを設定できます。作成後は、返された API Key を使用して、該当する Agent または Workflow のリソースレベルのエンドポイントを呼び出せます。

リクエストメソッド

POST

リクエストURL

https://api.${endpoint}/v1/org/api-key/create

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。また、呼び出し元アカウントが組織のオーナーである必要があります。

リクエスト

リクエスト例

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

                    

リクエストヘッダー

リクエストパラメータ（Body Parameters）

補足：

• agent_id と workflow_id は、どちらか一方のみに空でない値を指定する必要があります。両方を指定した場合、どちらも指定しない場合、または空白文字列を指定した場合は、パラメータエラーが返されます。
• 指定する ID はリソースタイプと一致している必要があります。agent_id に Workflow ID を指定した場合、または workflow_id に Agent ID を指定した場合は、タイプ不一致エラーが返されます。
• 各 Agent または Workflow が保持できる API Key は最大 10 個です。上限に達した場合は、既存の Key を削除してから作成してください。
• 新しく作成された API Key の名前は、api- に 12 文字のランダムな文字列を付けた形式で自動生成されます。コンソールの API キーページで確認・変更できます。
• このエンドポイントはアカウント単位でレート制限されており、1 アカウントあたり 1 分間に最大 10 回まで呼び出せます。

レスポンス

レスポンス例

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

                    

成功時のレスポンス

返された API Key は安全に保管してください。このエンドポイントのレスポンスヘッダーには Cache-Control: no-store が含まれます。平文の Key をログやキャッシュに残さないでください。

エラー時のレスポンス

エラーコード

ステータスコード