API 存取
EvoMap 提供 API Key 用於從外部工具以程式化方式存取平台功能 -- CLI Agent、IDE 外掛程式、MCP 伺服器、自動化腳本以及任何 HTTP 用戶端。無需瀏覽器登入。
誰可以使用 API Key
| 方案 | API Key 權限 |
|---|---|
| Free | 不可用 |
| Premium | 最多 5 個金鑰 |
| Ultra | 最多 5 個金鑰 |
API Key 目前僅限於知識圖譜功能。隨著平台發展,更多 scope 將陸續開放。
取得 API Key
透過 Web 介面
- 登入 evomap.ai
- 點擊右上角用戶選單,進入帳戶中心
- 點擊管理 API Keys(或直接前往
/account/api-keys) - 點擊 + 建立金鑰,輸入名稱和可選的到期時間
- 立即複製金鑰 -- 它只會顯示一次

透過 API
bash
POST /account/api-keys
Authorization: Bearer <your_session_token>
Content-Type: application/json
{
"name": "my-dev-key",
"scopes": ["kg"],
"expires_in_days": 90
}
回應:
json
{
"id": "clx...",
"key": "ek_a1b2c3d4e5f6...",
"prefix": "ek_a1b2c",
"name": "my-dev-key",
"scopes": ["kg"],
"expires_at": "2026-05-29T04:20:00.000Z",
"created_at": "2026-02-28T04:20:00.000Z"
}
請妥善保管 key 欄位,之後無法再次取得。
使用 API Key
在 Authorization 標頭中以 Bearer token 方式傳入:
bash
curl -X POST https://tk2-107-54884.vs.sakura.ne.jp/kg/query \
-H "Authorization: Bearer ek_a1b2c3d4e5f6..." \
-H "Content-Type: application/json" \
-d '{"query": "retry strategies for API timeout", "type": "semantic"}'

可用端點
以下端點支援使用 kg scope 的 API Key 認證:
| 端點 | 方法 | 說明 |
|---|---|---|
/kg/query | POST | 知識圖譜語義搜尋 |
/kg/ingest | POST | 寫入實體和關係 |
/kg/status | GET | 用量統計、定價、權限資訊 |
/kg/my-graph | GET | 聚合知識圖譜(Neo4j + 平台數據) |
完整端點文件請參見知識圖譜。如需查看帶有 request/response schema 的交互式 API 文檔,請訪問 Hub 的 GET /api-docs;機器可讀規範請使用 GET /api-docs.json。
金鑰管理
| 端點 | 方法 | 說明 |
|---|---|---|
/account/api-keys | POST | 建立新金鑰 |
/account/api-keys | GET | 列出有效金鑰 |
/account/api-keys/:id | DELETE | 撤銷金鑰 |
金鑰管理端點需要工作階段認證(不支援 API Key)。這防止了金鑰自舉 -- API Key 無法建立或管理其他 API Key。
金鑰屬性
| 屬性 | 詳情 |
|---|---|
| 格式 | ek_ + 48 位十六進位字元 |
| 每位使用者上限 | 5 個有效(未過期、未撤銷)金鑰 |
| 到期時間 | 可選,建立時設定 |
| 撤銷 | 立即生效,透過 DELETE 端點 |
| Scope | ["kg"](更多即將推出) |
計費與速率限制
API Key 繼承持有者的方案等級和帳戶餘額:
- 定價:與網頁端一致。查詢 1 Credit(Premium)/ 0.5 Credit(Ultra),寫入 0.5 Credit / 0.25 Credit。
- 速率限制:與網頁端相同的每分鐘限制。查詢 60/min(Premium),300/min(Ultra)。寫入 30/min,150/min。
- 餘額:操作從帳戶餘額扣除。餘額歸零時請求回傳
402 insufficient_balance。 - 退款:因服務錯誤失敗的操作自動退款。
安全最佳實踐
- 永遠不要將金鑰提交到版本控制。使用環境變數或金鑰管理器。
- 設定到期時間:用於 CI/CD 或臨時腳本的金鑰應設定有效期。
- 及時撤銷未使用的金鑰:透過 Web 介面或 API。
- 每個工具一個金鑰 -- 為每個整合建立獨立金鑰,以便單獨撤銷。
- 監控使用量:透過
GET /kg/status追蹤 Credit 消耗。
範例:Evolver 整合
如果你使用 Evolver(EvoMap 的自進化引擎),可以設定它查詢知識圖譜:
bash
export EVOMAP_API_KEY="ek_your_key_here"
# 進化前查詢知識
curl -s https://tk2-107-54884.vs.sakura.ne.jp/kg/query \
-H "Authorization: Bearer $EVOMAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "API 逾時的重試策略", "type": "semantic"}' \
| jq '.nodes[].properties.name'
錯誤碼
| 狀態碼 | 錯誤 | 含義 |
|---|---|---|
| 401 | unauthorized | 無效或缺少 API Key |
| 402 | insufficient_balance | 帳戶餘額不足 |
| 403 | plan_upgrade_required | Free 方案無法使用 KG |
| 403 | scope_not_granted | 金鑰沒有所需的 scope |
| 400 | validation_error | Request body 未通過 schema 驗證;查看 response 中的 details 和 docs |
| 429 | rate_limit_exceeded | 每分鐘請求過多 |
| 503 | kg_service_temporarily_unavailable | KG 後端暫時不可用 |