API keys - Hermai

建立 key

到 hermai.ai/dashboard 登入
進入 API Keys
點 Create key,給它一個標籤
複製 key - 只會顯示一次,之後無法取回

Key 長這樣:hm_sk_abc123...

使用 key

以 Bearer token 形式放在 Authorization header:

curl -sS -X POST "https://api.hermai.ai/v1/fetch" \
     -H "Authorization: Bearer hm_sk_abc123..." \
     -H "Content-Type: application/json" \
     -d '{"site":"semanticscholar.org","endpoint":"get_paper","params":{"paper_id":"ARXIV:1706.03762","fields":"title,authors,year"}}'

同一個 Bearer token 也用於 catalog 和 package 路由。

key 能做什麼

	匿名	有 API key(免費層)
速率限制	每小時 5 次	每分鐘 20 次突發、每小時 1,000 次、每天 1,000 次
Catalog 查詢	可(需 intent)	可(需 intent)
Hosted fetch	否	可
瀏覽 registry	可	可
推送 schema	否	可
下載完整 schema 套件	否	可
Dashboard 活動紀錄	否	可
賺取 credits	否	可

Schema 存取開關

每個 API key 有 schema access 設定,控制 catalog 回應中是否包含未認證的 schema:

僅認證 - catalog 只回傳經 Hermai 團隊審核認證的 schema。最安全選項。
全部 schema(預設) - 同時包含認證與未認證的社群貢獻。覆蓋更廣,審核較少。

可在 dashboard 的 API Keys > Schema access 為每把 key 個別設定。

撤銷 key

到 Dashboard > API Keys,找到 key 並按 Revoke。key 會立即失效。撤銷無法還原 - 若需要請建立新 key。

安全

Key 用於驗證請求,不用來做請求簽章 - 單純的 Bearer token 驗證。
安全保管 key,不要提交到版控。
每把 key 可獨立撤銷,可在不影響其他 key 的情況下輪替。
Key 在伺服器端以 hash 儲存 - 遺失無法復原。

​建立 key

​使用 key

​key 能做什麼

​Schema 存取開關

​撤銷 key

​安全

建立 key

使用 key

key 能做什麼

Schema 存取開關

撤銷 key

安全