开发者
身份认证
创建 sk_ API 密钥,为每个请求做认证,并在不影响生产环境的前提下轮换或过期密钥。
一个密钥解锁整套 API。 对 Buda REST API、MCP 端点以及嵌入流程的每一个请求,都使用与你账户绑定的同一个 API 密钥进行认证。在控制台里创建一次,将它作为 Bearer 令牌发送,几分钟内你就能调用托管智能体。
创建 API 密钥
打开「设置 → API 密钥」
在控制台中,进入 设置 → API 密钥,选择 新建密钥。
命名并设置有效期
为密钥起一个易于辨识的名称(例如 production-backend),并选择有效期:永不过期、7 天、30 天、90 天 或 365 天。短期密钥用于测试和 CI 更安全。
立即复制密钥
完整密钥——以 sk_ 为前缀——只在创建后显示一次。请立即把它复制到你的密钥存储中;此后 Buda 只保存一个打码版本,因此密钥再也无法被重新显示。
如果你错过了这次一次性显示,请删除该密钥并重新创建一个。之后无法找回完整的密钥值。
使用密钥
将密钥作为 Bearer 令牌放在 Authorization 请求头中。基础 URL 为 /api/v1。
# 验证你的密钥能否解析到你的账户
curl https://buda.im/api/v1/users/me \
-H "Authorization: Bearer sk_your_api_key"// Node / TypeScript
const API_BASE = "https://buda.im/api/v1";
const headers = {
Authorization: `Bearer ${process.env.BUDA_API_KEY}`,
"Content-Type": "application/json",
};
const me = await fetch(`${API_BASE}/users/me`, { headers }).then((r) => r.json());有效的密钥会解析到其所属用户;缺失或无效的密钥会返回 401 Unauthorized。Buda 会记录每个密钥最近一次请求的时间,方便你在删除密钥之前判断它是否仍在使用中。
轮换与过期
- 有效期 在创建时设定,且无法延长。要「续期」,请创建一个新密钥并停用旧的。
- 轮换 的做法是:先创建替换密钥,部署上线,然后再删除旧密钥——这样服务不会中断。
- 删除 密钥可随时在 设置 → API 密钥 中进行。删除立即且永久生效:使用该密钥的进行中请求会立刻开始失败。
安全最佳实践
- 像对待生产密钥一样对待 API 密钥。 切勿把它们硬编码进前端或移动端代码,也切勿提交到代码仓库。
- 隔离不同环境。 为测试、预发布和生产使用各自独立的密钥,这样吊销其中一个不会影响其他环境。
- 绝不要把密钥发送到浏览器。 对于客户端的智能体对话,请使用短期嵌入令牌,而不是你的
sk_密钥。 - 泄露即轮换。 如果某个密钥可能已泄露,请立即删除它并签发新的密钥。