Documentation Index
Fetch the complete documentation index at: https://docs.hermai.ai/llms.txt
Use this file to discover all available pages before exploring further.
1. 註冊
到 hermai.ai/register 建立免費帳號。不需要信用卡 — registry 完全免費使用。
2. 建立 API key
進入 Dashboard > API Keys 並建立新的 key。複製它 — 在需要驗證的請求中會用到。
匿名請求也可以用(每小時 5 次),但 API key 提供每小時 50 次、每天 500 次的額度。
3. 查詢 catalog
查詢某個網域的所有已知端點:
curl -H "Authorization: Bearer hm_sk_abc123..." \
-H "X-Hermai-Intent: looking up product endpoints on allbirds.com to build a price comparison agent" \
"https://api.hermai.ai/v1/catalog/allbirds.com"
{
"domain": "allbirds.com",
"endpoints": [
{
"name": "shopify_products",
"method": "GET",
"url": "https://www.allbirds.com/products.json",
"description": "Shopify store product catalog"
},
{
"name": "add_to_cart",
"method": "POST",
"url": "https://www.allbirds.com/cart/add.js",
"headers": { "Content-Type": "application/json" },
"kind": "api_call",
"params": [
{ "name": "id", "source": "body", "required": true },
{ "name": "quantity", "source": "body", "required": true }
]
}
]
}
4. 直接呼叫端點
用 catalog 回應裡的 URL、method、headers 自行呼叫網站:
curl -X POST "https://www.allbirds.com/cart/add.js" \
-H "Content-Type: application/json" \
-d '{"id": 41397031600208, "quantity": 1}'
5. 瀏覽 registry
在 hermai.ai/schemas 瀏覽,或透過 API:
# 列出所有 schema
curl "https://api.hermai.ai/v1/schemas"
# 依分類篩選
curl "https://api.hermai.ai/v1/schemas?category=commerce"
# 僅顯示已認證的 schema
curl "https://api.hermai.ai/v1/schemas?verified=true"
# 瀏覽 intent 分類樹
curl "https://api.hermai.ai/v1/categories"
6. 貢獻 schema
發現缺少的網站?用 CLI 記錄其端點並推送 schema:
# 安裝 CLI
go install github.com/hermai-ai/hermai-cli/cmd/hermai@latest
# 分類網站並找出公開路徑
hermai detect https://example.com
hermai wellknown example.com
# 從詳細頁面擷取內嵌資料
hermai probe --body https://example.com/products/123 | hermai extract
# 捕獲動態頁面的 XHR 流量(搜尋、購物車等)
hermai intercept https://example.com/search?q=test
# 撰寫 schema.json(參見 /zh-Hant/concepts/schemas),然後推送
hermai registry push schema.json
使用 Claude Code、Codex 或 Cursor? 執行 npx skills add hermai-ai/hermai-skills,你的 agent 就會代替你完成探索與推送。詳情參見 hermai-skills repo。 下一步
