X-API-Key 头中即可开始使用。无需刷新令牌或管理 OAuth 流程。
生成 API 密钥
- 登录 pioneer.ai。
- 前往 Settings → API Keys。
- 点击 Create key,为其命名,并复制密钥值。
在请求中传递密钥
在每个请求的X-API-Key 头中包含您的 API 密钥。以下示例展示了使用 curl、Python 和 JavaScript 发起相同推理调用的方法。
身份验证错误
其他所有错误代码都记录在 API 参考错误页面中。
通过 API 管理现有 API 密钥
请从 Pioneer 控制面板的 Settings -> API Keys 中创建新的 API 密钥。出于安全考虑,使用 API 密钥进行身份验证的请求不能创建其他 API 密钥;POST /create-api-key 仅限控制面板会话使用,当通过 X-API-Key 调用时将返回 403 Forbidden。
您可以使用现有密钥以编程方式列出和撤销现有密钥。
列出现有密钥
撤销是即时且永久的。使用被撤销密钥的任何请求都会收到
401 错误。如果需要不中断的访问,请在撤销现有密钥前先创建替换密钥。安全建议
- 为每个环境(开发、预发布、生产)使用一个密钥。
- 如果怀疑密钥已泄露,请立即撤销。
- 避免将密钥作为查询参数传递。始终使用
X-API-Key头。 - 在生产环境中,请从密钥管理服务中获取密钥,而不是从烘焙进容器镜像的环境变量中读取。