AI API Gateway Docs

ChatEasy API 快速开始

本文档面向 ChatEasy API 新用户,按照注册、登录、充值、创建 API 密钥、配置客户端、测试调用的顺序组织。照着步骤操作,即可完成一次完整接入。

01

文档概览

适用对象: 第一次使用 ChatEasy API 的用户,需要为 OpenAI 兼容客户端、Claude 工具、Codex、Cherry Studio、脚本或业务项目配置 API 的开发者。

ChatEasy API 是一个 AI API 管理与中转平台。用户登录后可以在控制台中查看账户余额、创建 API 密钥、充值或订阅、查看请求记录、观察 Token 与费用变化,并通过渠道状态判断模型服务是否正常。

A

账户与额度

先注册登录,再确认余额或订阅套餐。余额不足时,客户端调用可能会返回扣费或额度相关错误。

B

API 密钥

每个项目建议单独创建 API Key,方便后续停用、排查和统计,不建议多个项目共用同一个 Key。

C

用量排查

仪表盘、使用记录、渠道状态是最常用的三个排查入口,用于判断调用是否成功、费用是否异常、渠道是否波动。

02

完整流程

建议严格按以下顺序完成配置。不要一上来就把 API Key 接进正式项目,先用简单测试请求确认配置无误,再切换到生产场景。

  1. 注册 ChatEasy API 账号。 打开官网注册入口,填写邮箱、用户名、密码等信息;如果页面支持第三方登录,也可以按页面提示授权注册。
  2. 登录控制台。 登录后进入仪表盘,确认左侧菜单包含“仪表盘、API 密钥、使用记录、渠道状态、充值/订阅”等入口。
  3. 充值或订阅。 进入“充值/订阅”页面,选择额度、套餐或兑换码。付款前务必确认账号、金额和支付方式。
  4. 创建 API 密钥。 进入“API 密钥”页面,点击创建密钥,填写用途名称,创建后立即复制保存。不要公开展示真实 Key。
  5. 配置 Base URL 与 API Key。 在 OpenAI 兼容客户端或 SDK 中填写接口地址、API Key 和模型名称。字段名可能叫 Endpoint、API Host、Base URL 或 API 地址。
  6. 测试调用。 使用一个简单问题或低成本模型发起请求,确认客户端没有认证失败、模型不存在或余额不足等报错。
  7. 查看使用记录。 回到 ChatEasy 控制台,查看是否产生对应请求记录,并核对模型、Token、费用和状态。
03

注册账号

首次使用时,先打开 ChatEasy API 的注册页面。注册信息通常包括邮箱、用户名和密码。请使用自己能长期接收通知的邮箱,并保存好登录信息。

ChatEasy API 注册与登录页面截图
注册 / 登录入口示例。实际按钮、字段和登录方式以线上页面为准。

注册步骤

  1. 打开 ChatEasy API 注册入口。
  2. 填写邮箱、用户名和密码。
  3. 阅读页面提示,确认是否需要邮箱验证。
  4. 提交注册后返回登录页面。

注册建议

  • 密码建议使用字母、数字和符号组合。
  • 不要把账号密码交给他人代管。
  • 如果页面提示邮箱验证,请先完成验证再登录。
  • 注册失败时,优先检查邮箱格式、密码强度和网络环境。
04

登录控制台

注册完成后,使用账号密码登录。登录成功后通常会进入仪表盘页面。仪表盘是后续所有操作的起点,左侧菜单可以进入 API 密钥、使用记录、渠道状态、充值/订阅、订单和个人资料等页面。

ChatEasy API 注册登录页面截图
注册 / 登录页面截图。登录成功后即可进入 ChatEasy API 控制台。
登录后先确认

右上角账户是否正确,余额是否可用,左侧“我的账户”区域是否能进入 API 密钥和充值页面。

如果无法登录

检查账号密码、浏览器缓存、代理环境和是否被重定向到错误域名。必要时换浏览器重试。

如果页面空白

刷新页面,或检查浏览器是否拦截脚本。仍不正常时,可截图页面报错给管理员排查。

05

充值与订阅

在调用 API 之前,需要确认账户有可用余额或订阅套餐。进入左侧菜单的“充值/订阅”,选择合适的额度、套餐或兑换码方式。

步骤 操作 注意事项
1 进入“充值/订阅” 确认当前登录的是你要充值的账号。
2 选择额度、套餐或兑换码 新用户建议先小额测试,确认服务可用后再扩大额度。
3 确认金额和支付方式 付款前核对金额、账号和订单信息。
4 支付后回到仪表盘 刷新页面,确认余额或套餐状态已更新。
5 进入“我的订单”核对 如果余额未到账,用订单信息排查或联系客服。
06

创建 API 密钥

API 密钥是客户端调用 ChatEasy API 的凭证。建议按项目、工具或环境分别创建 Key,例如“codex-local”“cherrystudio-test”“production-server”。这样一旦某个项目出现异常消费,可以单独停用对应 Key。

ChatEasy API 密钥列表页截图
API 密钥列表页:点击右上角“创建密钥”开始创建新的访问令牌。
ChatEasy API 创建密钥弹窗截图
创建密钥弹窗:填写名称、选择分组,并按需设置额度、速率、IP 和有效期限制。
  1. 分组名称: 用于区分不同用途,例如 Claude Code、Codex。
  2. 选择分组: 必须选择,分组决定这个密钥可以使用哪些模型。
  3. 过期时间: 默认“永不过期”,也可以按需要设置有效期。
  4. 额度设置: 开启“无限额度”时,令牌实际可用额度仍受账户余额限制。
  5. 访问限制: 不熟悉时建议先保持默认。
安全提醒: API Key 等同于账户额度调用凭证。不要把 Key 写进前端代码、公开仓库、截图、朋友圈、教程图片或聊天记录。
07

接口配置

在 OpenAI 兼容客户端、SDK 或命令行工具里,通常需要填写三个字段:Base URL、API Key、Model。不同软件的字段名可能不同,但配置逻辑基本一致。

ChatEasy API 导入到 CC-Switch 截图
API 密钥列表页右侧提供“导入到 CCS”入口,可以辅助完成 CC-Switch 配置。
OpenAI 兼容配置示例
Base URL: https://chateasy.cc/v1
API Key: 你的 ChatEasy API 密钥
Model: 按 ChatEasy 支持的模型名称填写
客户端字段 填写内容 说明
Base URL / Endpoint / API Host https://chateasy.cc/v1 如果后台提供了专用线路或自定义域名,以实际地址为准。
API Key sk-... 填写在 API 密钥页面创建并复制的密钥。
Model 平台支持的模型名 模型名要完整匹配,拼写错误会导致模型不存在。
08

CC-Switch 使用教程

CC-Switch 是 Claude Code 和 Codex 的配置管理工具,可以统一管理供应商配置、MCP、Skills、系统提示词等内容。ChatEasy API 的“API 密钥”页面已经提供“导入到 CCS”入口,推荐优先使用这个入口完成配置,避免手动填写 Base URL、API Key 和模型分组时出错。

ChatEasy API 导入到 CCS 按钮截图
在 API 密钥列表页,找到目标密钥右侧的“导入到 CCS”。

通用步骤

系统 安装方式 说明
Windows 进入 CC-Switch GitHub Releases,下载适合 Windows 的安装包。 普通用户优先选择常规安装包,安装后启动 CC-Switch 主程序。
macOS brew tap farion1231/ccswitch
brew install --cask cc-switch
安装完成后可在“启动台”或“应用程序”中打开 CC-Switch。
Linux 进入 CC-Switch GitHub Releases 下载对应发行版安装包。 下载时注意版本号和架构,例如 amd64、arm64 等。
环境检查: 配置前建议先确认 Node.js、Claude Code 和 Codex 都已安装,并且运行过一次。第一次运行 CLI 通常会生成各自的配置目录,后续 CC-Switch 或手动配置才更顺利。

Claude Code 配置

  1. 打开 CC-Switch。进入主界面后,在顶部或侧边的分组中切换到 Claude / Claude Code 相关分组。
  2. 创建 ChatEasy 专用密钥。回到 ChatEasy 的“API 密钥”页面,创建一个给 Claude Code 使用的密钥,建议命名为 claude-code
  3. 选择 Claude 对应分组。创建密钥时选择 Claude Code 可用的分组,分组选错会导致模型不可用或请求失败。
  4. 导入到 CCS。在密钥列表右侧点击“导入到 CCS”,按 CC-Switch 提示完成导入。
  5. 启用配置。在 CC-Switch 主界面找到刚导入的 ChatEasy 配置,点击启用,确认状态变成使用中。
  6. 勾选 Claude Code 初次安装确认。如果 CC-Switch 设置中有“跳过 Claude Code 初次安装确认”之类选项,建议按工具提示开启,减少首次运行拦截。
  7. 终端测试。打开终端运行 claude,进入对话界面并能收到回复,即表示配置成功。

Codex 配置

  1. 打开 CC-Switch。在分组条中切换到 Codex。
  2. 创建 Codex 专用密钥。在 ChatEasy “API 密钥”页面创建新密钥,建议命名为 codex-clicodex-local
  3. 选择 Codex 分组。创建密钥时选择 Codex 可用分组;截图中可以看到密钥可以归属不同分组。
  4. 点击“导入到 CCS”。在对应密钥右侧点击导入,按 CC-Switch 的弹窗或提示完成添加。
  5. 启用 Codex 配置。回到 CC-Switch,在 Codex 分组下启用 ChatEasy 配置。
  6. 终端测试。运行 codex,看到 Codex 交互界面并能正常回复,即表示配置完成。

CC-Switch CLI 使用

CC-Switch 也提供 CLI / TUI 方式,适合服务器、SSH、macOS 终端或自动化场景。如果你不方便打开图形界面,可以使用 CC-Switch CLI 检查、切换和修复 Claude Code、Codex 的配置。具体命令以你安装的 CC-Switch 版本帮助信息为准。

建议: 不同 CLI 最好使用不同 API Key。这样某个工具消耗异常时,可以直接停用对应 Key,不影响其他工具。
09

CLI 配置教程

如果不使用 CC-Switch,也可以手动配置 Claude Code 和 Codex。建议按“检查 Node.js、安装 CLI、首次运行生成配置目录、写入配置文件、终端测试”的顺序完成。

环境检查

  1. 确认 Node.js / npm 可用。 在 Windows 或 macOS 终端运行 npm list -g --depth-0。如果提示 command not found,说明 Node.js 未安装或环境变量未生效。
  2. 安装 CLI。 需要用到 Claude Code 和 Codex 时,可分别安装对应命令行工具。
  3. 运行一次 CLI。 安装后分别运行 claudecodex。这一步很重要,因为首次运行通常会生成配置目录。
安装常用 CLI
npm i -g @anthropic-ai/claude-code@latest
npm i -g @openai/codex@latest
配置项 填写内容 说明
API Key 从 ChatEasy “API 密钥”页面复制 建议为每个 CLI 单独创建 Key,例如 codex-cli
Base URL https://chateasy.cc/v1 如果后台或管理员提供了专用地址,以专用地址为准。
Model 填写 ChatEasy 支持的模型名称 模型名需要完整匹配;分组选错也可能导致模型不可用。
Claude Code:settings.json
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://chateasy.cc",
    "ANTHROPIC_AUTH_TOKEN": "你的 ChatEasy Claude/CC 分组密钥",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
Claude Code 配置目录: Windows 输入 %userprofile%\.claude;macOS 在访达中按 Command + Shift + G 后输入 ~/.claude。如果没有 settings.json,手动新建。
Codex:config.toml
model_provider = "chateasy"
model = "gpt-5.5"
model_reasoning_effort = "high"
network_access = "enabled"
disable_response_storage = true
model_verbosity = "high"

[model_providers.chateasy]
name = "chateasy"
base_url = "https://chateasy.cc/v1"
wire_api = "responses"
requires_openai_auth = true
Codex:auth.json
{
  "OPENAI_API_KEY": "你的 ChatEasy Codex 分组密钥"
}
Codex 配置目录: Windows 输入 %userprofile%\.codex;macOS 在访达中按 Command + Shift + G 后输入 ~/.codex。常用文件是 config.tomlauth.json,没有就手动创建。
Claude Code 测试

保存 settings.json 后运行 claude,能进入对话并收到回复即成功。

Codex 测试

保存 config.tomlauth.json 后运行 codex,能正常回复即成功。

使用记录核对

测试成功后回到 ChatEasy 的“使用记录”,确认对应请求已经产生,并核对模型、Token 和费用。

排查口诀: 认证失败看 Key,连接失败看 Base URL,模型失败看模型名和分组,扣费异常看使用记录。
10

测试调用

配置完成后,先用简单请求测试,不要直接接入正式业务。测试目标是确认“能连通、能认证、模型存在、余额可扣、记录可查”。

测试请求思路
1. 选择一个低成本或常用模型
2. 发送一句简单问题,例如:请回复 ok
3. 检查客户端是否返回正常结果
4. 回到 ChatEasy 使用记录查看是否产生调用
5. 核对模型、Token、费用和状态
认证失败

检查 API Key 是否复制完整,前后是否多了空格,Key 是否已停用。

模型不存在

检查模型名是否拼写正确,当前渠道是否支持该模型。

余额不足

回到仪表盘确认余额或套餐状态,必要时充值后再测试。

11

常见问题

注册后为什么进不了控制台?

先确认账号是否完成验证,再检查浏览器缓存、代理环境和登录状态。如果仍无法进入,可换浏览器或无痕窗口重试。

充值后余额没有变化怎么办?

刷新仪表盘,进入“我的订单”核对订单状态。若订单已支付但余额未更新,保留订单号和付款截图联系平台处理。

创建 API Key 后在哪里填写?

在你的客户端或 SDK 配置里填写。常见字段包括 API Key、Secret Key、Authorization Key。不要把 Key 写进前端页面。

Base URL 应该填什么?

OpenAI 兼容客户端通常填写 https://chateasy.cc/v1。如果管理员提供了专用地址、自定义域名或其他线路,以实际提供地址为准。

为什么提示模型不存在?

模型名称必须和平台支持的名称完全一致。检查是否拼错、是否使用了客户端默认模型,或该模型当前是否不在可用渠道里。

如何定位是哪一个项目消耗额度?

为每个项目创建独立 API Key,并按用途命名。发生异常时,根据使用记录中的时间、模型、Key 和请求来源逐项排查。