这篇是一份个人上手笔记，不是 Yuan API 的官方公告。接口、模型 ID 和计费都会调整，请以当时的文档和控制台为准；不要把 API Key 贴到帖子、代码仓库或截图里。

官方入口： - 文档：https://doc.apixhm.com - 对话 API：https://api.apixhm.com - 文生图 Yuan Image：https://image.apixhm.com

1. 先准备一把 Key

  1. 打开 https://doc.apixhm.com ，按「注册账号 → 登录 → 充值或兑换 → 创建 API Key」走一遍。
  2. 控制台在 https://api.apixhm.com 。密钥在控制台创建，模型名称以控制台当前列表为准，不要猜名字或写死过期别名。
  3. 复制完整密钥。列表里打码的预览不能拿来调用。Key 放环境变量，不要写进仓库。

2. Codex / OpenAI 兼容客户端

Codex 以及多数 OpenAI SDK、Chatbox、Cherry Studio 一类工具，选「OpenAI 兼容」，Base URL 填：

https://api.apixhm.com/v1

注意末尾保留 /v1，不要再手动拼 /chat/completions。客户端会自己请求 /v1/chat/completions。API Key 只贴密钥本身，不要加 Bearer 前缀（curl 的请求头里才需要 Bearer）。

终端里可以先导出：

export OPENAI_BASE_URL=https://api.apixhm.com/v1
export OPENAI_API_KEY=你的Key

然后在 Codex 或同类客户端里使用同一组 Base URL 和 Key，模型 ID 从控制台复制。

3. 用 curl 先确认对话接口

把 YOUR_API_KEY 和模型名换成你自己的。模型名请从控制台或文档复制。

curl https://api.apixhm.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "换成控制台里的模型 ID",
    "messages": [{"role": "user", "content": "你好，用一句话介绍你自己"}]
  }'

能返回 choices 里的文字，就说明密钥、地址和模型 ID 是通的，再回到 Codex 里用同一套地址。

4. Python 示例

from openai import OpenAI

client = OpenAI(
    api_key="你的Key",  # 或 os.environ["OPENAI_API_KEY"]
    base_url="https://api.apixhm.com/v1",
)

resp = client.chat.completions.create(
    model="换成控制台里的模型 ID",
    messages=[{"role": "user", "content": "用三句话说明 OpenAI 兼容 Base URL 要带 /v1"}],
)
print(resp.choices[0].message.content)

5. Yuan Image：文生图

对话和画图不是同一个入口。文生图用 Yuan Image：https://image.apixhm.com 。不要把图片请求发到对话的 /v1/chat/completions。

Yuan Image 的 OpenAI 兼容 Base URL 一般是 https://image.apixhm.com/v1，文生图路径是 POST /v1/images/generations。模型名、尺寸和价格以 https://image.apixhm.com 与 https://doc.apixhm.com 当时的说明为准。

curl https://image.apixhm.com/v1/images/generations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "换成图像控制台里的模型 ID",
    "prompt": "a corgi running in a golden wheat field, cinematic",
    "size": "1024x1024"
  }'

成功时结果在 data 里。余额和价格以 Yuan Image 模型广场为准。

6. 小结

  1. 在 https://api.apixhm.com 准备完整 API Key，文档看 https://doc.apixhm.com 。
  2. Codex / OpenAI 兼容客户端的 Base URL 用 https://api.apixhm.com/v1 。
  3. 先用上面的 curl 或 Python 打通对话，再配到客户端。
  4. 生图改走 https://image.apixhm.com ，不要和对话路径混用。
  5. 模型 ID 以控制台为准；401 先核对密钥是否完整，404 先核对要不要 /v1。

以上是跟做笔记，欢迎补充你在 Codex 里踩过的坑。