Knocklog

Knocklog API

Knocklog API の公開説明です。AI エージェント向けの分析機能を提供します。どの AI エージェントがウェブサイトを訪問したか、それぞれが名乗るとおりのエージェントか、何を読んだか、また 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 エージェントを一覧表示	なし
POST /v1/classify	1 件のリクエストを識別して検証	なし
GET /v1/scan	サイトが AI エージェントをどのように扱うか確認	なし
POST /v1/scan	サイトが AI エージェントをどのように扱うか確認（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 エージェント向け

Model Context Protocol を通じて、同じ機能を利用できます。

• https://api.knocklog.ai/mcp/directory：公開ツール。サインイン不要
• https://api.knocklog.ai/mcp/account：1 つのプロジェクト。OAuth サインイン
• https://api.knocklog.ai/mcp：すべてのツール。引数としてキーを指定

公式 MCP レジストリに io.github.leonlesenechal/knocklog として登録されています。

Knocklog のその他のプロジェクト

• knocklog/ai-agents：AI エージェントとクローラーのオープンディレクトリ（JSON、CSV）

サポート

質問や不足しているエンドポイントについては、issue を作成するか [email protected] までご連絡ください。API の利用には利用規約が適用されます。このリポジトリ内のファイルは MIT ライセンスで提供されています。