文档中心快速开始
快速开始

5 分钟快速接入

Aiaimark 提供 OpenAI 兼容的 API。只需创建密钥、选择模型并修改 Base URL,即可在现有项目中使用平台上的主流大模型。

00
准备工作

开始前准备

一个可用的 Aiaimark 账号 账户中有可用额度 能够发送 HTTPS 请求的开发环境
01
账号

注册并登录平台

首次使用请先注册账号。注册完成后登录控制台,确认账户状态正常并有足够的可用额度。

02
鉴权

创建 API Key

进入控制台的 API Key 管理页面,创建一个新密钥并立即保存。密钥只应存放在服务端环境变量中,不要写入前端代码或提交到代码仓库。

妥善保管你的密钥

建议按项目分别创建密钥。若密钥意外泄露,请立即在控制台删除并重新创建。

03
模型

选择可用模型

前往模型广场查看当前可用模型及价格,复制你要调用的准确模型名称,并将它填入请求中的 model 字段。

查看模型广场
04
API 请求

发起第一次对话请求

平台接口兼容 OpenAI 请求格式。将示例中的 API Key 和模型名称替换为你的实际值后,即可发送请求。

Base URL
https://ai.aiaimark.com/v1
接口地址
https://ai.aiaimark.com/v1/chat/completions
鉴权方式
Authorization: Bearer sk-your-api-key
cURL终端
curl https://ai.aiaimark.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "YOUR_MODEL_NAME",
    "messages": [
      { "role": "user", "content": "你好,请介绍一下你自己" }
    ]
  }'

请求成功后,模型回复位于 choices[0].message.content。如果收到 401,请检查 API Key;如果提示模型不存在,请重新复制模型广场中的模型名称。

05
SDK

接入你的应用

现有 OpenAI SDK 只需替换 baseURL 和 API Key 即可接入。以下是 Node.js 示例:

JavaScriptOpenAI SDK
import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.AIAIMARK_API_KEY,
  baseURL: 'https://ai.aiaimark.com/v1',
})

const response = await client.chat.completions.create({
  model: 'YOUR_MODEL_NAME',
  messages: [{ role: 'user', content: '你好,请介绍一下你自己' }],
})

console.log(response.choices[0].message.content)
接入完成

现在可以根据业务需要调整模型、消息内容和生成参数。上线前请为请求添加超时、重试与错误日志。

06
Codex

在 Codex 中使用 Aiaimark

Codex 支持自定义模型 Provider。将 Aiaimark 配置为 Provider 后,Codex CLI、桌面端和 IDE 扩展即可通过平台调用支持 Responses API 的模型。

两种接入方式,任选一种

推荐使用 CC Switch,跟着截图即可完成配置。也可以选择手动配置,两种方式任选一种,无需重复操作。

推荐方式 · 图形界面

使用 CC Switch 接入 Codex

CC Switch 是第三方开源配置管理工具,方便在图形界面中添加和切换 Codex 供应商。选择此方式后,按以下步骤完成即可,无需再做手动配置。

以下为 CC Switch 4.0.15 中文界面的实际截图,红框数字对应操作位置,点击图片可放大。配置截图使用示例密钥和模型占位符,使用时请替换为自己的真实值;余额已遮盖。

  1. 安装并打开 CC Switch从 CC Switch 官网下载适合系统和芯片架构的安装包:Windows 使用 MSI 或便携版 ZIP,macOS 使用 DMG,Linux 使用 DEB、RPM 或 AppImage。请先确认本机已安装 Codex,并准备好 Aiaimark API Key、可用额度和支持 Responses API 与工具调用的模型名称。
macOS已安装 Homebrew 时也可使用
brew install --cask cc-switch
  1. 添加自定义供应商在 CC Switch 中选择 Codex,点击右上角「+ / 添加供应商」,再选择「自定义配置」。若界面提供「直连 / 路由 / 聚合」标签,本教程使用「直连」模式。不同版本的按钮名称可能略有差异。
图 1:先选左侧 Codex(①),进入添加供应商后选择「自定义配置」(②)。
图 1:先选左侧 Codex(①),进入添加供应商后选择「自定义配置」(②)。 查看大图
  1. 填写 Aiaimark 连接信息按下方对应关系填写表单。API Key 使用控制台创建的真实密钥;模型名从模型广场复制,不要直接使用示例占位符。
图 2:填写名称(①)、API Key(②)、API 请求地址(③)和默认模型(④)。
图 2:填写名称(①)、API Key(②)、API 请求地址(③)和默认模型(④)。 查看大图
供应商名称
Aiaimark
请求地址 / Base URL
https://ai.aiaimark.com/v1
API Key
你在 Aiaimark 控制台创建的密钥
默认模型
YOUR_CODEX_MODEL(替换为实际模型名称)
上游格式
Responses(原生)

名称填 Aiaimark,备注可以留空;「官网链接」只是快捷入口,可以填 https://aiaimark.com,它不能代替「API 请求地址」。将控制台创建的完整密钥粘贴到 API Key,不要加 Bearer 前缀或引号。

「API 请求地址」必须填 https://ai.aiaimark.com/v1,保留 /v1,不要追加 /responses 或 /chat/completions。上方表单填好后,下方 auth.json 和 config.toml 会自动更新,通常无需再手改这两块内容。

  1. 设置模型和接口格式在「模型列表」点击「手动添加」,将「菜单显示名」和「实际请求模型」都填为模型广场中支持 Responses API 与工具调用的准确名称。截图里的 YOUR_CODEX_MODEL 只是占位符。
图 3:模型列表填真实模型名(①);高级选项使用 Responses(原生)(②),完整 URL 保持关闭。
图 3:模型列表填真实模型名(①);高级选项使用 Responses(原生)(②),完整 URL 保持关闭。 查看大图

列表第一行就是默认模型;添加列表后,单独的「默认模型」输入框可能不再显示。也可以先点「获取模型列表」再选择模型;如果获取失败,使用手动添加即可。上下文窗口、思考等级和子代理模型不确定时保持默认。

展开「高级选项」,核对上游格式为「Responses(原生)」,「完整 URL」关闭。按本教程选择支持原生 Responses 的模型即可直连,不需要为了接入而额外开启路由或聚合。

CC Switch 会保存密钥并在启用供应商时写入本机配置,请勿分享包含真实密钥的截图或配置导出文件。已有手动配置时,先备份;如果编辑器中保留了上一节的 env_key,请移除该字段或确保对应环境变量与这里的密钥一致。

  1. 先保存配置核对名称、密钥、请求地址和模型后,点击页面右下角橙色的「添加」按钮;编辑已有供应商时按钮可能叫「保存」。返回列表,找到刚刚创建的 Aiaimark 卡片。供应商多时可以用右上角搜索。
图 4:右下角「添加」保存供应商;保存完成后,还需要回到列表切换。
图 4:右下角「添加」保存供应商;保存完成后,还需要回到列表切换。 查看大图
保存配置 ≠ 已启用

看到 Aiaimark 出现在列表中,只说明配置已保存。继续完成下一步,让 Codex 实际使用它。

  1. 在供应商列表启用 Aiaimark进入 Codex 的「直连」页,找到 Aiaimark 卡片。将鼠标移到卡片右侧的插头图标,确认提示为「切换」后点击;旧版可能直接显示「启用」。铅笔图标是编辑配置,不是启用。
图 5:直连页签(①)、卡片右侧的切换入口(②);截图来自已有路由的环境,所以额外显示「回到直连」(③)。
图 5:直连页签(①)、卡片右侧的切换入口(②);截图来自已有路由的环境,所以额外显示「回到直连」(③)。 查看大图

如果界面像图 5 一样提示「你在查看直连,Codex 目前是路由」,仅点击页签还没有切换模式。此时 Aiaimark 卡片的插头入口提示为「回到直连并使用」;点击后才会切回直连并选用它。首次使用、已经处于直连的用户不需要处理这一项。

切换后查看 Aiaimark 卡片是否出现「使用中」或当前供应商标识。图 5 的「直连时使用」只表示路由开启前的直连配置,不代表当前已经直连。

已经在用路由模式?如何确认当前供应商

如果你主动保留路由模式,在「路由」页对 Aiaimark 点击「路由到此」。图 6 展示的是路由模式的状态示例:顶部「路由生效中 → AIAIMark」与卡片「路由中」指向同一家,才说明路由选择正确。直连用户无需开启路由来得到相同画面。

图 6:已有路由环境的状态示例,顶部供应商(①)与卡片「路由中」(②)一致;这不是直连成功截图。
图 6:已有路由环境的状态示例,顶部供应商(①)与卡片「路由中」(②)一致;这不是直连成功截图。 查看大图

使用路由模式时需保持 CC Switch 运行;直连模式下,请求直接发往 Aiaimark。无论哪种模式,切换供应商或模型后都建议重启 Codex 再验证。

  1. 重启 Codex 并验证切换配置不会让已打开的 Codex 会话自动重新加载。请按你使用的客户端完成重启,然后新建会话测试。
Codex CLI
退出当前 Codex 进程,在项目目录重新运行 codex;可以用 /model 核对当前模型。
Codex 桌面端
彻底退出应用后重新打开。macOS 使用 ⌘Q,仅关闭窗口不算退出;Windows 使用应用的退出操作。
IDE 扩展
关闭并重新打开 IDE 窗口,或执行重新加载窗口,再打开 Codex 扩展的新会话。

发送一句「你好,请介绍一下你自己」,确认收到回复,再到 Aiaimark 控制台查看相同时间的调用记录与模型名称。两处都能对应上,才算验证完成;测速成功或看到卡片高亮,都不能代替这一步。

CC Switch 接入常见问题
  • 401 / 鉴权失败:重新核对 API Key 是否完整、有效,并检查旧配置中的环境变量是否仍在覆盖密钥。
  • 404 / 模型不可用:核对 Base URL 与模型名称,确认所选模型支持 Responses API 与工具调用。
  • 切换后没有生效:确认已点击「切换 / 启用」并重启 Codex;若使用 WSL、自定义配置目录或多套 Codex 环境,确认 CC Switch 管理的是实际运行环境的配置。
以后如何切换或恢复

以后可以在 CC Switch 中选择其他已保存的供应商,点击「切换 / 启用」并重启 Codex。要恢复原配置,选择之前保存的供应商;要恢复官方登录,选择 OpenAI 官方供应商,再按 Codex 的提示登录。