完整文档索引请见 llms.txt。本页面也提供 Markdown 版本。

获取你的 API key

API key 用于在服务端对 REST API 和实时 WebSocket 调用进行身份验证。/v1/public/* 下的公开 widget 端点无需 key；仪表盘中仅限管理区域的功能（API keys、计费、账户）通过仪表盘登录访问，也不需要 key。本指南介绍如何在应用中创建、管理和安全使用 API key。

创建 API Key

1. 登录你的 Ojin 仪表盘
2. 进入 API Keys 页面
3. 点击 Create API Key
4. 为 key 起一个便于识别的名字（如 "Development"、"Production"）
5. 点击 Create

重要提示：请立即复制并妥善保存你的 API key，它只会显示一次。

一个 API key 拥有对组织内 API 暴露的所有资源的无限制访问权限：agents、sessions、assets、模型配置和实时推理。切勿在客户端代码或公开仓库中暴露 key，也不要将其分享给未经授权的人员。

API Key 最佳实践

• 开发和生产环境使用不同的 key
• 用环境变量存储 key，避免公开暴露
• 把每个 key 都当作完整凭据对待。目前不支持按 key 划分权限范围：每个 key 都拥有相同的组织级访问权限
• 定期轮换 key 以增强安全性
• 一旦发现 key 泄露，立即在仪表盘中吊销
• 在生产环境中使用密钥管理服务
• 监控使用情况，及时发现可能预示泄露的异常模式

上一篇：Quickstart　下一篇：REST API 最后更新于 26 天前　这篇文档有帮助吗？