Skip to main content
Pioneer API 的每个请求都必须包含 API 密钥。Pioneer 使用一种简单的基于请求头的身份验证方案:将您的密钥放入 X-API-Key 头中即可开始使用。无需刷新令牌或管理 OAuth 流程。

生成 API 密钥

  1. 登录 pioneer.ai
  2. 前往 Settings → API Keys
  3. 点击 Create key,为其命名,并复制密钥值。
您只能在创建后立即查看完整密钥。Pioneer 不会存储密钥值,因此请在关闭对话框前复制它。如果丢失密钥,请撤销并重新生成一个。

在请求中传递密钥

在每个请求的 X-API-Key 头中包含您的 API 密钥。以下示例展示了使用 curl、Python 和 JavaScript 发起相同推理调用的方法。
请将 API 密钥存储在环境变量中(例如 PIONEER_API_KEY),而不是硬编码在源代码里。切勿将 API 密钥提交到版本控制系统。将 .env 文件加入 .gitignore,并在生产环境中使用密钥管理服务。

身份验证错误

其他所有错误代码都记录在 API 参考错误页面中。

通过 API 管理现有 API 密钥

请从 Pioneer 控制面板的 Settings -> API Keys 中创建新的 API 密钥。出于安全考虑,使用 API 密钥进行身份验证的请求不能创建其他 API 密钥;POST /create-api-key 仅限控制面板会话使用,当通过 X-API-Key 调用时将返回 403 Forbidden 您可以使用现有密钥以编程方式列出和撤销现有密钥。 列出现有密钥
撤销密钥
撤销是即时且永久的。使用被撤销密钥的任何请求都会收到 401 错误。如果需要不中断的访问,请在撤销现有密钥前先创建替换密钥。

安全建议

定期轮换 API 密钥,尤其是在共享环境或 CI/CD 流水线中使用时。为每个集成使用单独的密钥,这样您就可以撤销单个密钥,而不会影响其他服务。
  • 为每个环境(开发、预发布、生产)使用一个密钥。
  • 如果怀疑密钥已泄露,请立即撤销。
  • 避免将密钥作为查询参数传递。始终使用 X-API-Key 头。
  • 在生产环境中,请从密钥管理服务中获取密钥,而不是从烘焙进容器镜像的环境变量中读取。