概要とキー

Lockpick APIは、お使いのLockpickのアドレスにある /api/cli/v1 で動作します。CLIとMCPサーバーはどちらもこのAPIを使います。一部のツールは、クライアント側でAPIの読み取りを組み合わせます。待機ではスキャンの状態を確認し続け、評価ではそのスキャンの完了時刻、カバレッジ、未解決の検出事項にポリシーを当てはめます。これらの裏側にあるHTTPの操作は、リファレンスで確認できます。

キー

すべてのリクエストは、キーをベアラートークンとして送ります。

curl -H "Authorization: Bearer $LOCKPICK_KEY" https://www.lockpick.app/api/cli/v1/agent/me

キーは、CLIで lockpick login を実行してサインインすると取得できます。ブラウザーで承認を求められます。キーは lpk_ で始まり、承認した権限を持ちます。使われないまま一定期間が過ぎると期限切れになります。キーは Lockpick の AIに追加 から、CLIとキー タブで管理できます。

応答

すべての応答は同じ形のJSONです。成功すると data に値が入り、失敗すると error に値が入ります。

{ "data": { "sites": [] }, "error": null }

HTTP呼び出しが失敗すると、data は null になります。人が読める error の文字列と errorCode も返ります。操作が失敗した場合は、構造化されたエージェント用のエラーを details に含みます。認証や機能の制限で早い段階で拒否された場合は、details が省略されることがあります。

{
  "data": null,
  "error": "The request limit was reached. Retry in 60 seconds.",
  "errorCode": "RATE_LIMITED",
  "details": {
    "agentCode": "RATE_LIMITED",
    "message": "The request limit was reached.",
    "nextStep": "Wait before trying again.",
    "retryAfterSeconds": 60,
    "webUrl": null,
    "requestId": "req_example"
  }
}

retryAfterSeconds は秒数です。再試行の時刻が分からない場合は null になります。再試行の時刻が分かっている場合は、HTTPヘッダーの Retry-After にも入ります。webUrl は次の手順へのリンクで、ない場合は null です。requestId は、操作の失敗をサポートが追跡するために使います。MCPツールは、これらの項目をエラーオブジェクトにまとめます。その際、agentCode は code という名前になります。