Skip to main content
公共 API 使用 API 密钥认证。每个请求都必须在 X-API-Key 请求头中携带您的密钥。

请求头

获取 API 密钥

您可以从 Topify.ai 仪表盘的 Management > Members 中生成 API 密钥,或通过 智能体化设置 端点以编程方式生成。每个密钥的作用域为您的团队,并可访问该团队拥有的所有项目。仅团队管理员可以创建 API 密钥。 目前不签发项目级作用域的 API 密钥。请将每个 API 密钥视为整个团队的管理员凭证并妥善保管。
API 密钥仅供受信任的服务端使用。切勿将其嵌入浏览器 JavaScript、移动或桌面客户端代码、公开仓库、日志、AI 提示词或聊天记录。请从密钥管理器或受保护的环境变量加载;一旦泄露,立即轮换。
完整的 API 密钥只会在创建时显示一次。请立即将其保存到密钥管理器。Members 页面仅显示密钥前缀;如果完整值丢失,请创建替代密钥并禁用旧密钥。

速率限制

请求按 API 密钥进行速率限制。限额取决于您的套餐等级:

响应请求头

每个响应都会包含速率限制信息:

超出速率限制

当您超出限额时,API 会返回 HTTP 429

密钥生命周期

您可以随时从仪表盘停用或删除密钥。

示例请求

错误响应