Knocklog

Knocklog API

Knocklog API 的公开说明：用于 AI Agent 的分析。查看哪些 AI Agent 访问了网站、它们是否如实表明身份、阅读了哪些内容，以及 AI 助手带来的访客和潜在客户。

• 文档： https://knocklog.ai/docs/api
• OpenAPI 3.1： openapi.json，也可通过 https://api.knocklog.ai/openapi.json 实时获取
• 基础 URL： https://api.knocklog.ai

快速开始

# Check how a site treats AI agents (no key)
curl "https://api.knocklog.ai/v1/scan?domain=example.com"

# Identify one request
curl -X POST "https://api.knocklog.ai/v1/classify" -H "Content-Type: application/json" \
  -d '{"user_agent": "Mozilla/5.0; compatible; GPTBot/1.4; +https://openai.com/gptbot", "ip": "20.171.206.10"}'

# Create a project: returns an ingest key, an admin key and install code
curl -X POST "https://api.knocklog.ai/v1/projects" -H "Content-Type: application/json" -d '{"domain": "example.com"}'

# Read the report
curl "https://api.knocklog.ai/v1/traffic?days=30" -H "Authorization: Bearer $KNOCKLOG_ADMIN_KEY"

接入密钥（kl_ing_…）只会发送流量数据，可安全地用于网站上的采集器。管理密钥（kl_adm_…）可读取报告，请妥善保密。更多信息见 examples/。

端点

端点	功能	密钥
GET /v1/agents	列出已知的 AI Agent	无
POST /v1/classify	识别并验证单个请求	无
GET /v1/scan	检查网站如何对待 AI Agent	无
POST /v1/scan	检查网站如何对待 AI Agent（JSON 请求体）	无
GET /v1/plans	列出套餐	无
POST /v1/projects	创建项目	无
POST /v1/events	从采集器发送请求	接入（可选）
POST /v1/logs	导入访问日志	接入
GET /v1/plan	套餐和用量	接入或管理
GET /v1/traffic	流量报告	管理
GET /v1/account	账户概览	管理
GET /v1/ready-files	现成的 robots.txt 和 llms.txt（Pro）	管理
POST /v1/keys/ingest	创建新的接入密钥	管理
POST /v1/project/summary	通过电子邮件发送每周摘要	管理
POST /v1/integrations	Webhook、Slack 和公司电子邮件	管理
POST /v1/install/cloudflare	在 Cloudflare 上安装采集器	管理
POST /v1/billing/checkout	付费套餐的结账链接	管理
POST /v1/billing/portal	管理订阅的链接	管理
GET /v1/badge/{project}.json	徽章状态	无
GET /v1/badge/{project}.svg	徽章图片	无

Webhook：company.visited 和 lead.from_ai，使用 x-knocklog-signature 签名（示例）。

面向 AI Agent

通过模型上下文协议提供相同功能：

• https://api.knocklog.ai/mcp/directory：公开工具，无需登录
• https://api.knocklog.ai/mcp/account：单个项目，使用 OAuth 登录
• https://api.knocklog.ai/mcp：所有工具，将密钥作为参数传入

已在 官方 MCP Registry 中登记，名称为 io.github.leonlesenechal/knocklog。

Knocklog 的其他项目

• knocklog/ai-agents：AI Agent 和爬虫的开放目录（JSON、CSV）

支持

如有疑问或发现缺少的端点，请提交 issue 或发送邮件至 [email protected]。使用 API 须遵守条款。此仓库中的文件采用 MIT 许可证。