Our API
Our API Docs

教程

按工具选择对应教程,配置 Our API 后即可开始使用。所有示例中的域名请替换为你的 Our API 站点地址。

NewAPI / Our API

如何创建 API Key

Our API 基于 NewAPI 控制台管理令牌。按下列步骤创建 API Key,即可在 Claude Code、CodeX、Gemini CLI、OpenClaw 等工具中使用。

一、登录 Our API

  1. 打开站点

    在浏览器访问你的 Our API 地址,例如:

    http://www.cloudlinkai.top
  2. 注册 / 登录

    若尚未有账号,先完成注册;已有账号则直接登录进入控制台。

二、进入令牌管理

  1. 打开控制台

    登录后点击左侧(或顶部)菜单中的「控制台」/「Console」。

  2. 进入 API 令牌页面

    选择「令牌」或「API 令牌」(路径通常为 /console/token):

    http://www.cloudlinkai.top/console/token

三、添加令牌

  1. 点击「添加令牌」

    在令牌列表页点击「添加令牌」/「Create Token」按钮。

  2. 填写令牌信息
    • 令牌名称:随意填写,便于区分用途,例如 claude-codecodex-dev
    • 令牌分组:按工具选择对应专用分组(非常重要)。
    • 额度:建议按需设置;测试阶段可设为无限额度(若站点允许)。
    • 过期时间:按需要选择,其他选项保持默认即可。
  3. 按工具选择分组(务必选对)
    使用工具推荐分组
    Claude CodeClaude Code 专用
    CodeXCodeX 专用
    Gemini CLIGemini CLI 专用
    通用 OpenAI 兼容调用default / 通用分组
    注意:分组选错会导致对应 CLI 无法正常调用。创建前请确认分组名称与用途一致。
  4. 提交并复制密钥

    创建成功后,系统会显示形如 sk-xxxxxxxx 的 API Key。请立即复制并妥善保存——多数站点只展示一次完整密钥。

四、在工具中使用密钥

将密钥填入对应工具的配置文件或环境变量:

  • Claude Code:ANTHROPIC_AUTH_TOKEN(见 Claude Code 教程)
  • CodeX:OPENAI_API_KEY(见 CodeX 教程)
  • Gemini CLI:GEMINI_API_KEY(见 Gemini CLI 教程)
  • OpenClaw:在 onboard / 模型配置中填写 Base URL 与 API Key
Base URL 提示:OpenAI 兼容接口一般为 http://www.cloudlinkai.top/v1;Claude Code 使用 Anthropic 兼容地址时一般为 http://www.cloudlinkai.top(不要多余拼接错误路径)。以你站点文档为准。

五、安全建议

  • 不要把 API Key 提交到公开 Git 仓库。
  • 不同项目 / 工具建议使用不同令牌,便于限额与吊销。
  • 若密钥泄露,立刻在控制台删除或禁用该令牌并新建。
  • 可为令牌设置合理额度与过期时间,降低风险。
Claude Code

Claude Code 教程 · Our API

在 Windows / macOS 上安装 Claude Code,并接入 Our API。

系统要求

  • Windows 10/11,或 macOS 10.15+
  • Node.js 18+
  • 稳定的网络连接
  • Windows 建议安装 Git for Windows

1. 安装 Node.js

访问 Node.js 官网 下载 LTS 版本并安装。验证:

node -v
npm -v

2. 安装 Claude Code CLI

npm install -g @anthropic-ai/claude-code

验证安装:

claude --version

3. 配置 Our API

3.1 获取 Auth Token

访问 Our API 控制台 进行以下操作:

  • 点击「添加令牌」
  • 令牌分组请选择:Claude Code 专用(务必选择此分组,否则无法使用)
  • 令牌名称:随意填写
  • 额度建议:设置为无限额度(若允许)
  • 其他选项保持默认

详细步骤见 如何创建 API Key

3.2 配置 settings.json(推荐,永久生效)

重要:请将下方的 ANTHROPIC_AUTH_TOKEN 替换为你在 Our API 控制台(http://www.cloudlinkai.top/console/token)生成的 Claude Code 专用 API 密钥!

配置位置:

  • Windows:%USERPROFILE%\.claude\settings.json
  • macOS / Linux:~/.claude/settings.json
{
  "env": {
    "ANTHROPIC_BASE_URL": "http://www.cloudlinkai.top",
    "ANTHROPIC_AUTH_TOKEN": "sk-替换为你的API密钥"
  }
}
注意:配置文件更加安全且便于管理,修改后需要重启 Claude Code 才生效。

4. 启动 Claude Code

先进入工程目录:

cd 你的项目路径

启动:

claude

首次启动需完成:

  • 选择喜欢的主题(回车)
  • 确认安全须知(回车)
  • 使用默认 Terminal 配置(回车)
  • 信任工作目录(回车)

完成后即可开始编程。

Linux

Claude Code 教程 · Linux

Linux 版本教程,配置 Our API 后使用 Claude Code。

系统要求

  • Linux 发行版(Ubuntu 18.04+、CentOS 7+、Debian 9+)
  • Node.js 18+
  • 网络连接

1. 安装 Node.js

方法一:使用官方安装包(推荐)

  • 下载 LTS 版本的 Linux Binaries
  • 解压并安装到系统目录
  • 配置 PATH 环境变量

方法二:使用包管理器

Ubuntu / Debian

sudo apt update
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

CentOS / RHEL / Fedora

# Fedora
sudo dnf install -y nodejs npm

# CentOS / RHEL
sudo yum install -y nodejs npm

Arch Linux

sudo pacman -S nodejs npm

验证安装:

node -v
npm -v

2. 安装 Claude Code CLI

npm install -g @anthropic-ai/claude-code

验证:

claude --version

3. 配置 Our API

3.1 获取 Auth Token

访问 Our API 控制台

  • 点击「添加令牌」
  • 令牌分组请选择:Claude Code 专用(务必选择此分组,否则无法使用)
  • 令牌名称:随意填写
  • 额度建议:设置为无限额度
  • 其他选项保持默认

3.2 配置环境变量(settings.json,推荐)

重要提示:请将下方的 ANTHROPIC_AUTH_TOKEN 替换为你在 http://www.cloudlinkai.top/console/token 生成的 Claude Code 专用 API 密钥!

配置位置:~/.claude/settings.json

{
  "env": {
    "ANTHROPIC_BASE_URL": "http://www.cloudlinkai.top",
    "ANTHROPIC_AUTH_TOKEN": "sk-替换为你的API密钥"
  }
}
配置文件更加安全且便于管理,需要重启 Claude Code 才生效。

4. 启动 Claude Code

cd 你的项目路径
claude

首次启动后完成主题选择、安全须知、默认 Terminal、信任工作目录等提示后,即可开始编程。

CodeX

CodeX 教程 · Our API

官方教程文档:https://developers.openai.com/codex/cli

一、什么是 CodeX?

CodeX 是一款现代开发者的 AI 编程助手,通过集成 AI 能力,可大幅提升开发效率。其核心优势在于:

  • 快速生成高质量代码
  • 深度分析代码结构
  • 智能调试并修复问题
  • 自动生成代码文档
  • 无缝集成到开发流程

效率对比:

  • 传统开发:研究文档(30分钟)+编写后端(45分钟)+开发前端(60分钟)+调试(30分钟),总计约 2.5 小时
  • 使用 CodeX:描述需求(30秒)+获取代码(3秒)+测试(2分钟),总计约 3 分钟,效率提升可达数十倍

二、支持环境与系统要求

支持平台

  • Windows:Windows 10/11
  • macOS:macOS 10.15 (Catalina) 及以上
  • Linux:Ubuntu 18.04+、CentOS 7+、Debian 9+ 等主流发行版

系统要求

  • 必须安装 Node.js 18+
  • 稳定的网络连接

三、安装步骤

安装 Node.js

Windows / macOS

访问 Node.js 官网下载最新版本,双击安装包按默认选项完成安装。验证:

node -v

Linux(Ubuntu / Debian 示例)

sudo apt update
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

安装 CodeX

npm install -g @openai/codex

验证安装:

codex -V

启动命令:

codex

启动后可用 Ctrl+C 退出。

四、API 配置(关键步骤)

1. 获取令牌

CodeX 需要配合 API 服务使用。注册 / 登录地址:http://www.cloudlinkai.top

  • 访问 Our API 控制台
  • 进入「API 令牌」页面,点击「添加令牌」
  • 必须选择「CodeX 专用分组」(否则无法正常使用)
  • 填写令牌名称(自定义),建议设置为无限额度
  • 生成后保存 API 密钥(格式类似 sk-xxx

2. 创建 / 修改 config.toml(永久生效)

位置:

  • Windows:%USERPROFILE%\.codex\config.toml(即 C:\Users\当前用户名\.codex;没有该文件夹可自行新建,或先执行一次 codex
  • macOS / Linux:~/.codex/config.toml
model_provider = "ourapi"
model = "gpt-5.5"
network_access = "enabled"
disable_response_storage = true
personality = "pragmatic"
max_context = 1000000
model_auto_compact_token_limit = 900000
model_context_window = 1000000
model_reasoning_effort = "high"
service_tier = "fast"

[model_providers.ourapi]
name = "our api"
base_url = "http://www.cloudlinkai.top/v1"
wire_api = "responses"
requires_openai_auth = true

每次更改完配置,都需要重启 codex。

3. 创建 / 修改 auth.json(永久生效)

位置:

  • Windows:%USERPROFILE%\.codex\auth.json
  • macOS / Linux:~/.codex/auth.json
{
  "OPENAI_API_KEY": "替换为您的API Key"
}

切换模型示例:

codex -m gpt-5.5

五、基本使用方法

cd 你的项目文件夹路径
codex

首次启动完成主题、安全须知、默认 Terminal、信任目录等提示后即可使用。

六、常用命令参考

前端使用 MCP 的最佳实践

Apifox MCP 文档:https://docs.apifox.com/6327888m0

在项目根目录新建 .mcp.json 后开启 MCP 服务即可。

macOS

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": ["-y", "apifox-mcp-server@latest", "--project=你的项目ID"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "你的访问Token"
      }
    }
  }
}

Windows

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "apifox-mcp-server@latest", "--project=你的项目ID"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "你的访问Token"
      }
    }
  }
}

推荐命令模板:例如「xx 功能需要开发,接口地址:/user/list(Apifox 的接口地址),需要更新 mcp 并完成接口的调用、数据的渲染。」

七、高级技巧

项目记忆文件(AGENTS.md)

也可直接执行 /init。在项目根目录创建 AGENTS.md

# 项目配置
## 项目架构
- Next.js 15 + App Router
- TypeScript + Tailwind CSS
- shadcn/ui 组件库

## 编码标准
- 使用 2 空格缩进
- 优先使用函数式组件
- TypeScript 严格模式

IDE 集成

在 Cursor、IDEA、WebStorm 插件市场搜索 Codex 扩展;终端运行 codex 启动服务。

八、使用心得

  • 每次对话解决完一个问题,可用 /clear 清除上下文,避免 token 消耗过多;需要保留上下文时可使用 /compact
  • 尽量给 AI 参考内容,例如项目内现有代码、实体类、前端设计图等。
  • AI 写完的代码记得及时提交 git,避免改动过大难以回溯。
Gemini CLI

Gemini CLI 教程 · Our API

官方教程文档:https://geminicli.com/docs/get-started/

一、什么是 Gemini CLI?

Gemini CLI 是一款现代开发者的 AI 编程助手,通过集成 AI 能力,可大幅提升开发效率。其核心优势在于:

  • 快速生成高质量代码
  • 深度分析代码结构
  • 智能调试并修复问题
  • 自动生成代码文档
  • 无缝集成到开发流程

二、支持环境与系统要求

  • Windows 10/11、macOS 10.15+、主流 Linux 发行版
  • Node.js 18+
  • 稳定的网络连接

三、安装步骤

安装 Node.js

Windows / macOS:从官网安装后执行 node -v 验证。

Linux(Ubuntu / Debian):

sudo apt update
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

安装 Gemini CLI

npm install -g @google/gemini-cli

验证:

gemini --version

启动:

gemini

四、API 配置(关键步骤)

获取令牌

注册地址:http://www.cloudlinkai.top

  • 访问 Our API 控制台
  • 进入「API 令牌」页面,点击「添加令牌」
  • 必须选择「Gemini CLI 专用分组」(否则无法正常使用)
  • 填写令牌名称,建议无限额度
  • 保存 API 密钥(sk-xxx

创建 / 修改 .env(永久生效)

  • Windows:%USERPROFILE%\.gemini\.env
  • macOS / Linux:~/.gemini/.env
GEMINI_API_KEY=sk-替换为你的API密钥
GOOGLE_GEMINI_BASE_URL=http://www.cloudlinkai.top

每次更改完配置,都需要重启 gemini。

创建 / 修改 settings.json

  • Windows:%USERPROFILE%\.gemini\settings.json
  • macOS / Linux:~/.gemini/settings.json
{
  "selectedAuthType": "gemini-api-key",
  "theme": "Default"
}

切换模型示例:

gemini -m gemini-2.5-pro

五、基本使用方法

cd 你的项目文件夹路径
gemini

首次启动完成主题、安全须知、默认 Terminal、信任目录等提示后开始使用。

六、MCP 与高级技巧

可在项目根目录创建 .mcp.json 接入 Apifox 等 MCP 服务(配置方式与 CodeX 类似)。也可创建 AGENTS.md 作为项目记忆文件,或在 IDE 插件市场搜索 Gemini CLI 扩展。

七、使用心得

  • 及时 /clear/compact 管理上下文
  • 尽量提供现有代码、设计图等参考
  • 代码变更后及时 git 提交
检测报告

Our API 模型检测

站点地址:http://www.cloudlinkai.top

以下为各分组的专业检测结果说明(检测链接来自公开报告,供参考)。

分组:claude code

检测结果:https://hvoy.ai/report/V_MCIVypE2c

说明:max 号池,纯血模型。

分组:codex、codex-稳

检测结果:https://hvoy.ai/report/g64DMJwlYoY

分组:claude code 第三方 key

检测结果:https://hvoy.ai/report/6ucRyhr2z1g

分组:claude 混合

检测结果:https://hvoy.ai/report/nyjYssbkvPE

分组:claude-kiro

检测结果:https://hvoy.ai/report/aCvrPs_iM3M

说明:kiro 渠道因自行反代,部分结构可能与官方略有不同,但模型是真实的。

分组:claude code opus 特价 — 反重力渠道

检测结果:https://hvoy.ai/report/00g6146Ynjc

OpenClaw

OpenClaw(龙虾)安装使用详细教程 · Our API

OpenClaw(龙虾)是开源个人 AI 助手,支持多渠道接入。本教程说明如何安装,并将模型服务指向 Our API。

一、系统要求

  • Node.js >= 22(推荐)
  • macOS、Linux,或 Windows(建议 WSL2)
  • 稳定网络

二、快速安装

macOS / Linux / WSL2

curl -fsSL https://openclaw.ai/install.sh | bash

Windows(PowerShell)

iwr -useb https://openclaw.ai/install.ps1 | iex

已有 Node 时手动安装

npm install -g openclaw@latest

验证:

openclaw --version

三、初始化配置

openclaw onboard --install-daemon

按向导完成模型、网关、渠道等配置。新手也可使用:

openclaw onboard --flow quickstart

四、接入 Our API

  1. 创建 API Key

    在 Our API 控制台添加令牌(见 如何创建 API Key),按你实际使用的模型协议选择合适分组。

  2. 填写 Base URL 与密钥

    在 onboard / 模型设置中配置:

    • Base URL(OpenAI 兼容):http://www.cloudlinkai.top/v1
    • API Key:你的 sk-xxx
    • 模型名:以 Our API 控制台可用模型列表为准
  3. 验证服务
    openclaw doctor
    openclaw gateway status
    openclaw dashboard

    浏览器访问本地控制面板(常见为 http://127.0.0.1:18789)确认可对话。

五、日常使用建议

  • 先只接入一个渠道或一个模型,跑通最小闭环再扩展
  • 密钥不要写入公开仓库;可用环境变量或本地配置文件保存
  • 遇到问题先运行 openclaw doctor 自检
更多官方安装说明见 openclaw.ai。原 Notion 页中的 Code Link 品牌说明已统一替换为 Our API。