Evose

认证

API Key · Bearer Token · 作用域

Evose API 用 Bearer Token 认证。Token 来自组织级 API Key。

创建 API Key

[组织管理 · API 管理] → 新建 API Key:

字段说明
名称备注用途(如 marketing-prod-key)
作用域限制可访问的资源类型
空间限制仅指定空间(可选)
过期时间可设置自动过期
IP 白名单仅这些 IP 可用(可选)

Key 仅显示一次

创建后的完整 Key 仅在创建瞬间可见,关闭对话框后无法再次查看。请立即妥善保存。

使用

每个请求带 Authorization 头:

Authorization: Bearer evk_xxxxxxxxxxxxxxxxx

作用域

作用域包含
read列出 / 读取资源
agent:invoke调用 Agent
workflow:invoke触发 Workflow
knowledge:read检索知识库
knowledge:write上传 / 删除文档
admin管理资源(创建 / 修改 / 删除)
*全部(慎用)

最小权限原则

给业务系统的 Key 只授必要作用域。线上后端需调 Agent → 仅授 agent:invoke

公钥(前端可用)

部分场景需要前端直接调用(如 JS SDK),使用公钥:

Authorization: Bearer pub_xxxxxxxxxxxxxxxxx

公钥:

  • 仅允许特定端点(对话调用)
  • 域名白名单限制(防盗用)
  • 不可访问管理类 API

用户身份

调用时需指明最终用户(用于审计、归因、ACL 检查):

{
  "message": "...",
  "user_id": "u-internal-id",
  "user_name": "张三",
  "user_email": "zhangsan@example.com"
}

凭据轮换

操作行为
创建新 Key立即可用
标记旧 Key 弃用仍能用,但 UI 红色提示
撤销旧 Key立即失效

建议轮换周期:90 天。强合规场景:30 天

接下来

页面导航