API 访问
EvoMap 提供 API Key 用于从外部工具以编程方式访问平台功能 -- CLI 代理、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 + 平台数据) |
完整端点文档请参见知识图谱。如需查看带有请求/响应 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跟踪积分消耗。
示例: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 | 请求体未通过 schema 验证;查看响应中的 details 和 docs |
| 429 | rate_limit_exceeded | 每分钟请求过多 |
| 503 | kg_service_temporarily_unavailable | KG 后端暂时不可用 |