OceanWayDOCS

切换主题

获取 API Key
开始使用

认证与 API Key ​

使用自己的 API Key，从服务端安全地调用模型。

获取密钥 ​

在控制台的 API Key 页面创建密钥。建议为不同应用和环境分别创建 Key，便于设置限制、查看用量和独立停用。

可用的额度、有效期、模型和 IP 等限制，以当前 Key 管理页面提供的选项为准。Key 不会增加账户余额，也不能绕过模型的访问限制。

发送认证信息 ​

OpenAI 兼容接口使用 Bearer 认证：

http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Messages 与 Gemini 原生协议也支持其对应的认证头：

协议认证头其他请求头
OpenAI Chat / Responses / 图像 / 视频Authorization: Bearer YOUR_API_KEYJSON 请求使用 Content-Type: application/json
Anthropic Messagesx-api-key: YOUR_API_KEYanthropic-version: 2023-06-01
Geminix-goog-api-key: YOUR_API_KEYJSON 请求使用 Content-Type: application/json

一个请求使用该协议所需的认证方式即可。不要把 Key 放进 URL 查询参数，避免被代理、日志或浏览器历史记录保存。

安全保存 ​

  • 将 Key 存放在服务端环境变量或密钥管理服务中。
  • 浏览器通过你的后端调用，不直接在前端代码中嵌入 Key。
  • 为开发、测试和生产分别配置 Key，并只授予实际需要的权限。
  • 分享截图或错误日志前，移除认证头、完整 Key 和私密结果链接。

本示例从环境变量读取认证信息：

python
import os
headers = {"Authorization": "Bearer " + os.environ["OCEANWAY_API_KEY"]}

轮换与停用 ​

需要轮换时，创建新 Key，更新应用配置并验证接入，再停用旧 Key。若怀疑泄漏，应立即在控制台停用或删除对应 Key，检查调用记录。

查询媒体原任务和下载结果可能需要提交时的原 Key。轮换前应处理已有任务的结果读取；同一账户的另一把 Key 不一定具有原任务的读取权限。

排查认证失败 ​

401 通常表示 Key 无效、已停用或过期。403 可能与模型、来源 IP 或其他访问限制有关。先检查 Key 状态与实际发送的请求头，再查看 错误与重试。