Skip to content

API 密钥

API 密钥让程序 —— 涌智IM 桥、CLI、MCP 客户端、你自己的脚本 —— 代表你调用平台。密钥是账户级的,并带有限制其能力范围的围栏

创建密钥

  1. 设置 → API 密钥(API Keys)
  2. 填名称(可选),勾选权限知识库范围模型范围(围栏)。
  3. 生成密钥
  4. 复制密钥 —— 以 rag_ 开头。只显示一次,妥善保存,像对待密码一样。

创建 API 密钥:权限、知识库范围、模型范围生成密钥:勾选对话/检索/写入/工作流权限,并把知识库与模型范围收紧到需要的子集

权限

密钥只授予你勾选的权限:

权限允许
chat发起对话 / Agent 请求
search查询知识库
write修改项目 / 文档
workflow触发工作流

围栏(范围)

围栏把密钥限制到你账户的一个子集:

  • allowedProjects —— 仅这些项目 / 知识库。
  • allowedChannels —— 仅这些模型渠道。
  • allowedModels —— 仅这些模型。

一把收得很紧的密钥(如 chat + search、单项目、单模型)可以放心交给集成:即便泄漏, 其影响面正好就是你圈定的范围。

密钥已生成,只显示一次密钥生成后只显示这一次(图中已打码)——立即复制保存;下方「我的密钥」列出所有已生成密钥,可随时吊销

使用密钥

作为 bearer token 发给平台的公开 API:

bash
curl https://www.hipmmai.com/v1/chat \
  -H "Authorization: Bearer $HIPMMAI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "总结我项目里最新的文档", "projectId": "…"}'

同一把密钥也能用于指向平台 MCP 端点的 MCP 客户端,让外部助手检索你的知识库。

吊销

随时在设置 → API 密钥里删除某把密钥,它会立即失效。吊销一把密钥绝不影响其他密钥。

下一步

  • 涌智IM —— 用二维码把密钥绑到涌智IM App,全程不暴露密钥本身。
  • hipmmcode —— 以编程方式驱动智能体。