Übersicht und Schlüssel

Die Lockpick-API liegt unter /api/cli/v1 auf Ihrer Lockpick-Adresse. Die CLI und der MCP-Server nutzen beide. Einige Werkzeuge setzen API-Lesevorgänge im Client zusammen: Das Warten fragt einen Scan wiederholt ab, und die Bewertung wendet eine Richtlinie auf den Abschlusszeitpunkt, die Abdeckung und die offenen Befunde an. Die HTTP-Operationen dahinter finden Sie in der Referenz.

Schlüssel

Jede Anfrage trägt einen Schlüssel als Bearer-Token.

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

Einen Schlüssel erhalten Sie, indem Sie sich mit der CLI anmelden, lockpick login. Dabei müssen Sie die Anmeldung in Ihrem Browser bestätigen. Schlüssel beginnen mit lpk_, tragen die Berechtigungen, die Sie freigegeben haben, und laufen ab, wenn sie nicht genutzt werden. Verwalten Sie sie in Lockpick unter Zu deiner KI hinzufügen auf dem Tab CLI und Schlüssel.

Antworten

Jede Antwort ist JSON in derselben Form, mit data, wenn es funktioniert hat, und error, wenn nicht.

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

Fehlgeschlagene HTTP-Aufrufe liefern data: null, eine lesbare error-Zeichenkette und einen errorCode. Fehler bei Operationen enthalten außerdem details mit dem strukturierten Agent-Fehler. Frühe Ablehnungen bei Authentifizierung oder Funktionen können ihn weglassen.

{
  "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 ist eine Anzahl von Sekunden oder null, wenn keine Wartezeit bekannt ist. Eine bekannte Wartezeit steht außerdem im HTTP-Header Retry-After. webUrl ist ein Link zum nächsten Schritt oder null. requestId erlaubt dem Support, einen Operationsfehler nachzuverfolgen. MCP-Werkzeuge übernehmen diese Felder in ihr Fehlerobjekt, wobei agentCode dort code heißt.