Visión general y claves

La API de Lockpick vive en /api/cli/v1 en tu dirección de Lockpick. La CLI y el servidor MCP la usan los dos. Algunas herramientas componen lecturas de la API en el cliente: la espera consulta un escaneo, y la evaluación aplica una política a su hora de finalización, cobertura y hallazgos abiertos. Consulta la referencia para ver las operaciones HTTP detrás de ellas.

Claves

Cada solicitud lleva una clave como token bearer.

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

Obtienes una clave iniciando sesión con la CLI, lockpick login, que te pide aprobarla en tu navegador. Las claves empiezan con lpk_, llevan los permisos que aprobaste y caducan cuando no se usan. Gestiónalas en Lockpick en Añadir a tu IA, en la pestaña CLI y claves.

Respuestas

Cada respuesta es JSON con la misma forma: data se rellena cuando funciona y error cuando no.

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

Las llamadas HTTP fallidas devuelven data: null, una cadena error legible y un errorCode. Los fallos de operación también incluyen details con el error estructurado del agente; los rechazos tempranos de autenticación o de funciones pueden omitirlo.

{
  "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 es un número de segundos, o null cuando no se conoce ningún tiempo de reintento. Un tiempo de reintento conocido también aparece en la cabecera HTTP Retry-After. webUrl es un enlace al siguiente paso o null; requestId permite al soporte rastrear un fallo de operación. Las herramientas MCP normalizan estos campos en su objeto de error, donde agentCode se llama code.