Visão geral e chaves

A API do Lockpick fica em /api/cli/v1, no seu endereço do Lockpick. A CLI e o servidor MCP usam ambos a API. Algumas ferramentas compõem leituras da API no cliente: esperar faz consultas a uma verificação, e a avaliação aplica uma política à hora de conclusão, à cobertura e aos achados abertos. Veja a referência para as operações HTTP por trás delas.

Chaves

Toda requisição carrega uma chave como token bearer.

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

Você obtém uma chave fazendo login com a CLI, lockpick login, que pede que você a aprove no seu navegador. As chaves começam com lpk_, carregam as permissões que você aprovou e expiram quando não são usadas. Gerencie-as no Lockpick, em Adicionar à sua IA, na aba CLI e chaves.

Respostas

Toda resposta é JSON, no mesmo formato, com data preenchido quando funcionou e error preenchido quando não funcionou.

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

Chamadas HTTP com falha retornam data: null, uma string error legível e um errorCode. As falhas de operação também incluem details com o erro estruturado do agente; recusas antecipadas de autenticação ou de recurso podem omiti-lo.

{
  "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 é um número de segundos, ou null quando nenhum tempo de nova tentativa é conhecido. Um tempo de nova tentativa conhecido também aparece no cabeçalho HTTP Retry-After. webUrl é um link para o próximo passo, ou null; requestId permite que o suporte rastreie uma falha de operação. As ferramentas MCP normalizam esses campos no objeto de erro delas, onde agentCode se chama code.