GFoxAPI 文档中心

大多数 OpenAI 兼容客户端填写下面这个地址：

https://api.goufox.com/v1

如果软件会自动拼接 /v1，则填写：

https://api.goufox.com

如果软件要求填写完整接口地址，可以填写：

https://api.goufox.com/v1/chat/completions

首次连通性测试

创建 Key 后，建议先请求模型列表。返回模型数据，说明密钥和基础地址可正常使用。

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

GFoxAPI会接入多个模型渠道。不同渠道的倍率、稳定性、上下文长度和能力不同，请以控制台实际显示为准。

Codex CLI 适合开发者在终端里进行代码生成、项目修改、代码解释和调试。下面以GFoxAPI为例， 演示如何把 Codex CLI 配置为使用GFoxAPI的 OpenAI 兼容接口。

一、准备环境

https://github.com/microsoft/terminal/releases

node -v

二、安装 Codex CLI

如果 npm 下载较慢，可以先切换国内镜像源，再安装 Codex CLI。

npm config set registry https://registry.npmmirror.com
npm i -g @openai/codex
codex --version

三、配置文件位置

四、手动配置 config.toml

如果文件不存在就新建。如果原来已有配置，建议先备份再覆盖。

model = "请填写控制台可用的 Codex/代码模型"
model_provider = "goufox"
model_reasoning_effort = "high"
sandbox_mode = "workspace-write"
approval_policy = "on-request"
file_opener = "vscode"
web_search = "cached"
suppress_unstable_features_warning = true

[history]
persistence = "save-all"

[tui]
notifications = true

[shell_environment_policy]
inherit = "all"
ignore_default_excludes = false

[features]
unified_exec = false

[model_providers.goufox]
name = "goufox"
base_url = "https://api.goufox.com"
wire_api = "responses"
requires_openai_auth = true

五、配置 auth.json

把下面的 sk-... 替换成你在GFoxAPI后台创建的 API Key。

{
  "OPENAI_API_KEY": "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
}

六、启动 Codex CLI

普通用户建议直接使用默认启动方式：

codex

七、Windows 常见问题

node -v

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

八、macOS / Linux 安装

macOS 和 Linux 用户可以直接用终端安装 Node.js 20+，也可以使用 Volta 管理 Node 版本。

curl https://get.volta.sh | bash
volta install node@20
npm i -g @openai/codex
codex --version

然后按上面的路径创建 ~/.codex/config.toml 和 ~/.codex/auth.json。

九、WSL2 / SSH 服务器配置

远程服务器或 WSL2 环境推荐使用 Volta 安装 Node，再安装 Codex CLI。

curl https://get.volta.sh | bash
volta install node@20
npm i -g @openai/codex
codex --version

十、可选：一键配置工具

只有在GFoxAPI官方公告明确提供一键配置工具时，才按公告中的命令执行。不要安装搜索结果、陌生群文件或第三方教程中的未知 npm 包；没有官方公告时，请优先使用上面的手动配置方式。

十一、Codex CLI 报错处理

如果你不想安装 Codex CLI，只使用 Codex App 桌面客户端，可以按本章节配置。 核心思路是：在用户目录下创建 .codex 文件夹，并放入 auth.json 和 config.toml 两个配置文件。

一、创建配置目录

配置文件一般放在用户目录下的 .codex 文件夹里。

如果文件夹不存在，可以手动创建。macOS / Linux 也可以用终端创建：

mkdir -p ~/.codex

二、创建 auth.json

在 .codex 文件夹内创建 auth.json，内容如下。请把示例 Key 换成你在GFoxAPI后台生成的 sk- 开头密钥。

{
  "OPENAI_API_KEY": "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
}

三、创建 config.toml

继续在 .codex 文件夹内创建 config.toml。如果你之前已有老配置，请先备份。

model = "请填写控制台可用的 Codex/代码模型"
model_provider = "goufox"
model_reasoning_effort = "high"
sandbox_mode = "workspace-write"
approval_policy = "on-request"
file_opener = "vscode"
web_search = "cached"
suppress_unstable_features_warning = true

[history]
persistence = "save-all"

[tui]
notifications = true

[shell_environment_policy]
inherit = "all"
ignore_default_excludes = false

[features]
unified_exec = false

[model_providers.goufox]
name = "goufox"
base_url = "https://api.goufox.com"
wire_api = "responses"
requires_openai_auth = true

四、重启 Codex App

两个文件创建完成后，完全退出 Codex App，再重新打开。重新打开后，Codex App 会读取新的 .codex 配置并使用GFoxAPI。

五、401 报错排查

六、仍然无法配置怎么办

如果你手动创建不了 .codex 文件夹，或配置后一直不生效，可以先参考上一节 Codex CLI 配置使用教程 中的安装与配置方式，或联系管理员协助排查。

OpenClaw 适合需要本地或服务器部署网页聊天界面的用户。完成 OpenClaw 官方安装后， 可以手动编辑 ~/.openclaw/openclaw.json，把GFoxAPI作为 OpenAI Responses 兼容提供商接入。

一、基础环境检查

建议先安装 Git 和 Node.js，再安装 OpenClaw。Node.js 建议使用 22.16+，如条件允许可使用 Node.js 24。

https://git-scm.com/downloads
https://git-scm.com/download/win

https://nodejs.org/en/download/

安装完成后，在终端检查版本：

git --version
node -v
npm -v

二、可选：官方一键配置

只有在GFoxAPI官方公告明确提供安装包、仓库地址或一键配置命令时，才按该公告执行。 未提供时请直接使用下面的手动配置方式，不要安装来源不明的 npm 包，也不要执行第三方教程中的一键脚本。

三、方案二：手动配置 openclaw.json

安装 OpenClaw 后，编辑配置文件：

~/.openclaw/openclaw.json

把 models 和 agents 相关配置调整为下面示例。请把 sk-xxxxxxxx 替换成你的GFoxAPI密钥。

{
  "models": {
    "providers": {
      "goufox": {
        "baseUrl": "https://api.goufox.com/v1",
        "apiKey": "sk-xxxxxxxxxxxxxxxxxxxxxxxx",
        "auth": "api-key",
        "api": "openai-responses",
        "authHeader": true,
        "models": [
          {
            "id": "请填写控制台中的模型名称",
            "name": "GFoxAPI模型",
            "reasoning": true,
            "input": ["text", "image"],
            "contextWindow": 400000,
            "maxTokens": 128000
          }
        ],
        "headers": {
          "User-Agent": "OpenClaw",
          "Accept": "application/json"
        }
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "goufox/请填写控制台中的模型名称"
      },
      "workspace": "/root/.openclaw/workspace",
      "compaction": {
        "mode": "safeguard"
      },
      "maxConcurrent": 4,
      "subagents": {
        "maxConcurrent": 8
      },
      "thinkingDefault": "high"
    }
  }
}

四、推理强度设置

如果模型支持推理强度，可以在 agents.defaults 中设置：

"thinkingDefault": "high"

也可以按需要改成：

"thinkingDefault": "xhigh"

五、本机安装提示词

如果你想让 Codex 帮你在本机自动部署 OpenClaw，可以复制下面这段提示词：

请帮我在当前系统上部署 OpenClaw，并最终让我能通过网页打开聊天界面。

要求：
1. 不要只分析，直接执行安装和配置
2. 优先使用 OpenClaw 官方推荐安装方式，不要只停留在克隆 GitHub 仓库
3. 自动识别当前系统是 Windows、macOS 还是 Linux，并选择对应安装方式
4. 安装完成后，配置我的 goufox 提供商
5. 模型使用GFoxAPI控制台中可用的模型
6. 需要我输入 API Key 时再停下来问我
7. 最终目标是让我可以打开本机的 OpenClaw 网页聊天界面
8. 安装完成后，帮我检查：
   - openclaw --version
   - openclaw gateway status
   - openclaw models status
9. 如果网页打不开、缺少 token、模型未注册、API Key 未导入，请继续处理，不要停在中间
10. 如果是桌面系统并且可打开浏览器，就直接帮我打开网页；如果不能自动打开，就输出可直接访问的完整地址

我的模型提供商信息：
- provider: goufox
- baseUrl: https://api.goufox.com/v1
- auth: api-key
- api: openai-responses
- model: 请使用GFoxAPI控制台中的可用模型

六、远程服务器安装提示词

如果你是在 Linux 服务器或 SSH 环境部署，建议默认不要直接暴露公网端口，优先使用 SSH 端口转发。

请帮我在当前远程服务器上部署 OpenClaw，并最终让我能从本地电脑访问网页聊天界面。

要求：
1. 不要只分析，直接执行安装和配置
2. 优先使用 OpenClaw 官方推荐安装方式，不要只停留在克隆 GitHub 仓库
3. 自动识别当前系统和 shell，并选择对应安装方式
4. 安装完成后，配置我的 goufox 提供商
5. 模型使用GFoxAPI控制台中可用的模型
6. 需要我输入 API Key 时再停下来问我
7. 远程服务器默认不要直接暴露公网端口，优先使用安全方式访问
8. 如果 OpenClaw 只监听 127.0.0.1，请继续帮我提供正确的 SSH 端口转发命令
9. 安装完成后，帮我检查：
   - openclaw --version
   - openclaw gateway status
   - openclaw models status
10. 最终请明确告诉我：
   - 服务是否启动成功
   - 监听地址和端口
   - 我在本地电脑上应该执行什么 SSH 端口转发命令
   - 然后应该打开哪个网址

我的模型提供商信息：
- provider: goufox
- baseUrl: https://api.goufox.com/v1
- auth: api-key
- api: openai-responses
- model: 请使用GFoxAPI控制台中的可用模型

七、安装后检查

openclaw --version
openclaw gateway status
openclaw models status

获取模型列表

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

Chat Completions

curl https://api.goufox.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "请替换为控制台中的模型名称",
    "messages": [
      {
        "role": "user",
        "content": "你好"
      }
    ],
    "stream": true
  }'

Responses API

适用于 Codex 等使用 Responses 协议的客户端。模型是否支持该接口，请以GFoxAPI控制台的实际能力为准。

curl https://api.goufox.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "请替换为控制台中的模型名称",
    "input": "你好"
  }'

Python SDK

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.goufox.com/v1"
)

response = client.chat.completions.create(
    model="请替换为控制台中的模型名称",
    messages=[
        {"role": "user", "content": "你好"}
    ]
)

print(response.choices[0].message.content)

Python Responses API

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.goufox.com/v1"
)

response = client.responses.create(
    model="请替换为控制台中的模型名称",
    input="你好"
)

print(response.output_text)

JavaScript SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.goufox.com/v1"
});

const response = await client.chat.completions.create({
  model: "请替换为控制台中的模型名称",
  messages: [
    { role: "user", content: "你好" }
  ]
});

console.log(response.choices[0].message.content);

JavaScript Responses API

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.goufox.com/v1"
});

const response = await client.responses.create({
  model: "请替换为控制台中的模型名称",
  input: "你好"
});

console.log(response.output_text);

如控制台已开启充值功能，用户可按页面提供的方式创建订单并完成充值。订单状态和余额变化请以控制台记录为准。

平台采用按量计费。实际消耗通常和输入 tokens、输出 tokens、模型倍率、图片/文件/长上下文等能力有关。

• 低倍率模型更适合日常聊天、批量处理和新手测试。
• 高倍率模型更适合复杂代码、长文分析和高质量输出。
• 余额不足时会返回 INSUFFICIENT_BALANCE。
• 模型价格和倍率请以控制台显示为准。

• 不要公开分享 API Key。
• 不要把 API Key 写进前端网页、公开仓库或群聊。
• 不要高频并发压测平台。
• 不要使用平台进行违法违规、攻击、诈骗、垃圾信息等用途。
• 生产环境建议在服务端转发请求，并设置超时、重试和备用模型。

联系管理员时，请尽量提供下面信息，方便快速定位问题：

账号邮箱：
使用的软件：
模型名称：
报错截图：
报错时间：
Request ID：
是否测试过其他模型：