DeerAPI-API文档
  1. 最佳实践
DeerAPI-API文档
  • 快速开始
    • 快速开始
    • 入门必看
    • DeerAPI 公告
  • API 参考
    • 报错状态码说明
    • OpenAI格式
      • 聊天
      • response
      • gpt-4o-image生图
      • 识图
      • 图像
      • 图像编辑(gpt-image-1)
      • 嵌入
      • Realtime
      • 获取模型列表
      • response id获取结果
      • Hunyuan3D
    • Anthropic 格式
      • Anthropic Claude
    • Gemini
      • 调用 gemini-2.5-flash-image 指南
      • Gemini生图
    • Midjourney 图像生成
      • 快速教学-完整流程一遍过
      • 任务查询
        • 分页查询
        • 指定ID获取任务
      • 提交Imagine任务
      • 提交视频任务
      • 提交编辑任务
      • 提交Action任务
      • 提交Blend任务
      • 提交Describe任务
      • 提交Modal
    • 图像生成
      • Replicate(image)
        • 创建任务-通用
        • 创建任务 -flux-kontext-pro、max
        • 创建任务-black-forest-labs/flux-1.1-pro
        • 创建任务-black-forest-labs/flux-1.1-pro-ultra
        • 查询任务
        • 创建任务
      • Replicate(test-bria)
        • 创建任务-通用
        • 创建任务-black-forest-labs/flux-1.1-pro
        • 创建任务-black-forest-labs/flux-1.1-pro-ultra
        • 查询任务
        • 创建任务
      • Flux(images)
        • 创建任务-通用
        • 生成图片
        • 微调(暂不可用)
        • 查询任务
        • 生成图片(replicate格式)
      • ideogram(暂时下架)
        • 官方文档(实时更新)
        • Generate(文生图)
        • Generate 3.0(文生图)
        • Remix(混合图)
        • Remix 3.0(混合图)
        • Upscale(放大高清)
        • Reframe 3.0(重构)
        • Describe(描述)
        • Replace Background 3.0(背景替换)
        • Edit(编辑)
        • Edit 3.0(编辑)
      • Recraft(暂时下架)
        • 附录
        • Generate Image(生成图片)
        • Vectorize Image(矢量化图片)
        • Remove Background(删除背景)
        • Clarity Upscale(清晰度提升)
        • Create style(创建样式)
        • Generative Upscale(生成高清)
    • 音乐生成
      • Suno
        • 设置 suno 版本
        • Suno API 场景应用指南
        • 生成歌词
        • 生成音乐
        • 上传音乐
        • 歌曲拼接
        • 全轨声曲分离
        • 单轨声曲分离
        • 新建 Persona
        • 查询单个任务
        • 生成 mp4 mv 视频
        • 获取 wav 格式文件
        • Timing:歌词、音频时间线
        • 批量查询任务
      • Udio(暂不可用)
        • 生成音乐
        • 查询单个任务
    • 视频生成
      • veo3
        • veo3-chat格式
        • 提交视频生成任务-测试中
        • 查询视频生成状态-测试中
      • seedace测试中
        • 视频-测试中
          • seedance
          • seedance-video
          • seedance-video get
        • 图片
          • seedance-image-generation
          • seedance-image-edits
      • runway(video)
        • 官方格式
          • 图像生成视频
          • 视频生视频
          • 提升清晰度
          • 文生图
          • 控制角色
          • 获取任务详细信息
        • 逆向格式
          • generate(文本)
          • generate(参考图片)
          • video2video 视频转视频 风格重绘
          • Act-one 表情迁移
          • feed-获取任务
      • kling (video)
        • Callback协议
        • 多模态视频编辑
          • 初始化待编辑视频
          • 增加视频选区
          • 删减视频选区
          • 清除视频选区
          • 预览已选区视频
          • 创建任务
        • 生成图像
        • 扩图
        • 文生视频
        • 图生视频
        • 多图参考生图
        • 多图参考生视频
        • 视频特效
        • 视频延长
        • 虚拟试穿
        • 对口型
        • 文生音效
        • 视频生音效
        • 查询任务(单个)
      • luma (video)
        • 官方API格式
          • 生成视频
          • 单个查询任务
      • MiniMax 海螺(video)
        • 官方文档
        • 视频生成
        • 查询任务
        • 文件下载
      • PIKA(暂不可用)
        • 通用版
          • generate video
          • 查询视频任务
        • feed
        • generate(参考视频/扩展视频)
        • generate(参考图片)
        • generate(文本)
      • sora(暂时下架)
        • 逆向格式
          • 创建视频
          • 生成视频
          • 查询视频任务
    • 音频
      • 文本转音频
      • 音频转文本
      • 创建翻译
  • 代码示例
    • 代码示例
  • 集成指南
    • 应用集成指南
      • DeerAPI 本站调用
      • OpenManus
      • Chatbox
      • CherryStudio
      • COZE
      • Cursor
      • Lobe-Chat
      • NEXT CHAT (ChatGPT Next Web)
      • AnythingLLM
      • cline
      • gptme
      • LangChain
      • ChatHub
      • ChatAll
      • Dify
      • Zotero
      • librechat
      • avante.nvim
      • IntelliJ Translation Plugin
      • FastGPT
      • OpenAI Translator
      • Open WebUI
      • obsidian的text generator插件
      • STranslate
      • 沉浸式翻译
      • Pot 翻译
      • 欧陆翻译
      • GPT 学术优化(gpt_academic)
      • utools-ChatGPT 好友
      • 懒人客服
    • 最佳实践
      • Claude code 接入说明
      • Deerapi 账户余额查询API 使用说明
      • 使用 DeerAPI 和 OpenAI 官方 API 的重试逻辑说明文档
      • Midjorney调用最佳实践
      • Runway调用最佳实践
      • Gemini CLI 接入说明
      • Codex 接入说明
  • 定价计费
    • 关于价格
    • 关于分组
  • 帮助中心
    • 帮助中心
    • 接口稳定性
    • 常见误区
    • 使用困惑
    • 隐私政策
    • 服务条款
  1. 最佳实践

Codex 接入说明

🚀 好消息! 我们现在支持 Codex 中转服务!通过 DeerAPI,您可以无缝接入 OpenAI 的强大代码生成模型(如 GPT-5),无需担心地域限制或复杂配置。无论您是开发者还是AI爱好者,都能轻松启动您的编程助手。立即试用,提升您的编码效率!(注册 DeerAPI 获取您的 API 密钥:https://deerapi.com)

💡 准备工作#

在开始之前,请确保您的环境满足以下要求:
操作系统: Windows 10/11、macOS 10.15+、Ubuntu 20.04+ 或 Debian 10+
Node.js: 版本 18 或更高(如果使用 npm 安装)

1️⃣ 安装 Node.js (已安装可跳过)#

注意:请确保您的 Node.js 版本 ≥ 18.0

Windows 用户#

Ubuntu / Debian 用户#

macOS 用户#


2️⃣ 安装 Codex#

选择一种安装方式:

3️⃣ 配置 Codex#

DeerAPI 作为中转代理,提供简单配置。创建配置文件以连接我们的服务。

步骤一:创建配置文件夹#

步骤二:创建 config.toml 文件#

在 ~/.codex/config.toml 中添加以下内容(替换 sk-xxx 为您的 DeerAPI 密钥):
model_provider = "deerapi"
model = "gpt-5"
model_reasoning_effort = "high"
disable_response_storage = true

[model_providers.deerapi]
name = "deerapi"
base_url = "https://api.deerapi.com/v1"
wire_api = "responses"
env_key = "sk-xxx"

步骤三:创建 auth.json 文件#

在 ~/.codex/auth.json 中添加以下内容(替换 sk-xxx 为您的 DeerAPI 密钥):
{
  "OPENAI_API_KEY": "sk-xxx"
}

4️⃣ 开始使用#

配置完成后,进入您的项目目录并启动 Codex:
首次运行时,根据提示完成初始化(如主题选择、安全确认)。现在,您可以与 AI 编程搭档互动,生成代码、调试等!🚀
提示:如果需要永久环境变量支持,可参考 OpenAI 官方文档 或添加 export 命令到您的 shell 配置文件。

❓ FAQ#

重要说明:DeerAPI 仅作为官方 Codex 的中转代理,支持标准 API 请求。如有问题,优先检查密钥和网络。
Q: 安装失败怎么办?
A: 确保 Node.js 或 Homebrew 已正确安装。检查 npm/brew 权限。
Q: API 报错或连接失败?
A: 可能是网络不稳或密钥无效。重启 Codex 并重试;验证 config.toml 和 auth.json 中的密钥。
Q: 为什么使用 "gpt-5" 模型?
A: 这是 DeerAPI 支持的先进模型示例。目前仅支持gpt-5。
Q: 如何获取密钥?
A: 在 DeerAPI 注册,生成以 sk- 开头的令牌。额度设为无限以避免限制。
Q: 状态显示 offline 或 fetch failed?
A: 这可能因本地网络问题。尝试使用代理工具连接国际网络,或检查 Google 连通性(Codex 会测试它)。
如需更多帮助,联系 DeerAPI 支持!享受高效编码之旅。🌟
修改于 2025-09-09 10:30:40
上一页
Gemini CLI 接入说明
下一页
关于价格
Built with