Skip to main content

API overview

The dashboard, the AgentShield CLI and the Comply scanner all talk to the same JSON API at https://app.aiagentlens.com/api. Anything the dashboard can show, the API can return.

  • Requests and responses are JSON. Errors return a JSON body with an error string and an appropriate status code.
  • Authentication is a bearer token; see Authentication.
  • API access is included in every plan.

Public endpoints

Three endpoints need no authentication:

EndpointPurpose
GET /healthLiveness, version and build commit.
GET /releases/latestThe latest AgentShield release version and download links.
POST /api/playground/analyzeEvaluate a shell command or MCP tool call against the community rules without executing it. Rate limited per IP.
curl -s https://aiagentlens.com/api/playground/analyze \
-H 'Content-Type: application/json' \
-d '{"type":"shell","command":"cat ~/.ssh/id_rsa"}'
{"decision":"BLOCK","rules":["protected-path"],"reasons":["Access to protected path denied: ~/.ssh/**"]}

For an MCP call send {"type":"mcp","tool":"read_file","args":{"path":"~/.aws/credentials"}}.