Oplaude Docs
← 平台首页 进入控制台 ↗

Oplaude API 新手接入指南

适合第一次使用 AI API 中转、CC Switch 桌面管理工具与 Codex / Claude Code CLI 的开发者。按照本教程指引,您可以顺畅完成账户注册、获取 API Key、导入客户端配置并进行首次调用与报错排查。

控制台网址 (Web Console) console.oplaude.com
API 基础请求地址 (Base URL) https://api.oplaude.com/v1
专属客服 QQ 49596969
⚠️ 先保护好您的 API 密钥
API 密钥相当于您的账户登录密码。切勿发送给任何人,切勿放进公开代码仓库、聊天群或截图展示中。初次接入建议先小额充值进行连通性测试。

开始前先了解

  • 控制台和 API 是两个地址:网页可视化操作(注册、创建密钥、看账单)使用 console.oplaude.com,编程客户端及 SDK 请求使用 https://api.oplaude.com/v1
  • 分组决定模型和计费:创建密钥时选择的分组决定了可用模型、倍率、吞吐限速与底层调度线路。
  • 建议先小额测试:配置好后先发起一次简短调用,确认控制台 [使用记录] 中扣费与日志正常,再投入正式开发。

一、注册并登录 Oplaude

打开 Oplaude 注册页 按照提示创建账户;已有账户可直接打开 登录页

  1. 使用能够正常接收邮件的常用邮箱。
  2. 设置独立的高强度密码。
  3. 登录后直接进入控制台,切勿在其他第三方未知网站输入 Oplaude 账户信息。

二、充值并确认余额

当前需在控制台左侧打开 微信充值,按照说明联系管理员充值;专属客服 QQ 为 49596969

  1. 转账前请务必确认收款信息与客服账号。
  2. 到账后刷新控制台界面,确认右上角账户余额已实时更新。
  3. 倍率、模型价格及退款规则以控制台当前展示及实际请求扣费为准。

三、创建 API 密钥

在控制台打开 API 密钥 页面,点击右上角 创建密钥

  • 名称:填写易识别的用途,例如 我的 Codex生产环境测试
  • 分组:选择当前账户支持的销售分组(不同分组支持的模型与倍率有所差异)。
  • 自定义密钥:新手建议关闭,由系统自动生成高熵值安全密钥。
  • 额度限制:测试环境可配置小额上限;填写 0 表示不设上限。

四、选择分组和模型

在控制台左侧打开 可用渠道 查看当前账户权限,打开 模型广场 查看完整模型名称与实时倍率。

支持通过终端 API 直接列出当前密钥可用的全部模型列表:

curl https://api.oplaude.com/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

五、使用 CC Switch 桌面工具一键导入

CC Switch 是当前最为流行的 Claude Code、Codex 等 AI 编程 CLI 统一配置管理桌面客户端。

5.1 一键导入步骤

  1. CC Switch 官网 安装并启动客户端。
  2. 回到 Oplaude 的 API 密钥 列表。
  3. 在目标密钥右侧点击 导入到 CCS
  4. 浏览器弹出协议唤起确认框时,选择“允许”。
  5. 核对供应商名称为 Oplaude API,地址为 https://api.oplaude.com/v1
  6. 启用该配置后,在终端重启 Codex 或 Claude Code 即可!

5.2 手动添加供应商表单

字段填写内容
供应商名称Oplaude API
官网链接https://console.oplaude.com
API KeyOplaude 控制台创建生成的 API 密钥
API 请求地址https://api.oplaude.com/v1
默认模型当前分组实际支持的完整模型 ID(如 gpt-5.6-sol

六、手动配置 Codex (config.toml)

若习惯手动修改配置文件,可直接编辑本地 Codex 配置文件:

  • Windows: %USERPROFILE%\.codex\config.toml
  • macOS / Linux: ~/.codex/config.toml
model = "gpt-5.6-sol"
model_provider = "oplaude"

[model_providers.oplaude]
name = "Oplaude API"
base_url = "https://api.oplaude.com/v1"
env_key = "OPLAUDE_API_KEY"
wire_api = "responses"

并在终端导出环境变量:

# macOS / Linux
export OPLAUDE_API_KEY="你的_OPLAUDE_API_KEY"

# Windows PowerShell
$env:OPLAUDE_API_KEY="你的_OPLAUDE_API_KEY"

七、通过标准 API 直接调用

7.1 Responses API (推荐 Codex 及最新工具)

curl https://api.oplaude.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-sol",
    "input": "你好,请只回复:Oplaude 配置成功",
    "stream": false
  }'

7.2 Chat Completions API (兼容 OpenAI SDK / LangChain / Cursor)

curl https://api.oplaude.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-sol",
    "messages": [
      {"role": "user", "content": "你好,请只回复:调用成功"}
    ]
  }'

八、查看 Token 和扣费

调用成功后,请打开控制台的 使用记录 页面,确认刚才的调用已产生统计记录。能看到确切的 输入 Token输出 Token最终扣费,即代表整体配置已 100% 成功。

九、高频报错与排错手册 (FAQ)

1. 报错 401 Unauthorized 或 invalid_api_key

  • 原因:传入的 API Key 错误,或复制时遗漏了字符/包含了前后多余空格。
  • 排查:确认填入的是 Oplaude 生成的下游 Key,不是网站登录密码,也不是 OpenAI 官方或其他第三方站点的 Key。检查密钥状态是否处于启用状态。

2. 报错 403 GROUP_NOT_ALLOWED

  • 原因:当前 API Key 所绑定的分组权限不足或被设为私有。
  • 排查:在控制台 API 密钥列表中将分组切换到公开常规分组,或联系客服授权私有通道。

3. 报错 429 Too Many Requests 或 并发已满

  • 原因:达到了该分组的最大并发限制或每分钟请求频次(RPM)上限。
  • 排查:适当减慢并发调用频率,避免单机多线程连续轰炸。

4. 报错 502 Bad Gateway 或 Upstream service temporarily unavailable

  • 原因:上游特定供应商节点发生短暂抖动,或底层自动故障转移正在进行。
  • 排查:等待 3~5 秒后重试。若持续报错,请携带发生时间、模型名称和 Request ID 联络技术支持。

十、密钥安全规范

  1. 不同客户端、服务器或用途,建议创建不同的独立 API 密钥,以便追踪消耗并能在泄露时精准停用。
  2. 严禁将真实 API 密钥提交至 GitHub / Gitee 等公共 Git 仓库。
  3. 在向技术客服求助时,请遮挡密钥明文,仅提供 Request ID 或错误信息即可。

十一、客户支持

如果您在配置或使用过程中遇到任何疑问,欢迎随时联系平台技术客服:

客服 QQ:49596969

立即开始您的顶尖 AI 编程之旅

统一接入 Claude 3.7、GPT-5.6、Codex 与 DeepSeek,零迁移成本。

免费注册 Oplaude 账号 ↗