开发文档

把模型接入这件事说清楚

从模型广场复制模型名或配置，按这里的 Base URL 和 Key 接入。文档只保留真正会影响调用、计费和排障的内容。

最小配置OpenAI-compatible

quickstart.sh

export APIEX_API_KEY="sk-..."

curl https://apiex.ai/v1/chat/completions \
  -H "Authorization: Bearer $APIEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen3-max",
    "messages": [
      {"role": "user", "content": "hi"}
    ]
  }'

Base URLhttps://apiex.ai/v1

鉴权Authorization: Bearer $APIEX_API_KEY

模型 ID从模型广场复制，避免手写出错

价格口径USD / 1M tokens，人民币仅作估算展示

OpenAI SDK

替换 baseURL、API Key 和 model 即可接入。

CLI / Agent

Claude Code、Codex、Cursor 等工具配置集中放在这里。

模型选择

按场景、厂家、价格和访问延迟选择模型。

快速开始

1. 创建 API Key

进入控制台并完成登录。
进入 API Key 管理页面，创建一个新的密钥。
确认账户有可用余额或企业额度。

2. 选择模型

进入模型广场，按供应商、上下文长度、输入输出价格、能力标签选择模型。接入初期建议先使用显式模型 ID。

3. 验证连通性

connectivity.sh

export APIEX_API_KEY="sk-xxxxxxxx"

curl -s -o /dev/null -w "%{http_code}\n" \
  -H "Authorization: Bearer $APIEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"openai/gpt-5.2","messages":[{"role":"user","content":"hi"}]}' \
  https://apiex.ai/v1/chat/completions

标准接入

大多数 OpenAI SDK 生态只需要替换 Base URL、API Key 和模型 ID。

python

from openai import OpenAI

client = OpenAI(
    api_key="APIEX_API_KEY",
    base_url="https://apiex.ai/v1",
)

completion = client.chat.completions.create(
    model="openai/gpt-5.2",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "how are you?"}
    ],
)

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

Python

推荐使用官方 OpenAI SDK，并替换 `base_url`。

Node.js

同样使用 OpenAI SDK，配置 `baseURL` 与 API Key。

curl

适合排查鉴权、路径、模型 ID 和网络连通性。

Claude Code CLI 接入

Claude Code 读取 Anthropic 兼容配置。建议把密钥写到用户级配置，不要提交到项目仓库。

~/.claude/settings.json

mkdir -p ~/.claude

cat > ~/.claude/settings.json <<'EOF'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://apiex.ai/anthropic",
    "ANTHROPIC_API_KEY": "sk-xxxxxxxx",
    "ANTHROPIC_MODEL": "anthropic/claude-sonnet-4.6"
  },
  "includeCoAuthoredBy": false
}
EOF

claude /logout 2>/dev/null || true
unset ANTHROPIC_AUTH_TOKEN

如果出现认证冲突，确认本机没有同时设置 OAuth Token 和 API Key，只保留一种认证方式。

Codex CLI 接入

Codex 建议使用 Responses API，并把配置写在用户级 `~/.codex/config.toml`。

~/.codex/config.toml

mkdir -p ~/.codex

cat > ~/.codex/config.toml <<'EOF'
model_provider = "apiex"
model = "openai/gpt-5.2"

[model_providers.apiex]
name = "apiex"
base_url = "https://apiex.ai/openai/v1"
env_key = "APIEX_API_KEY"
wire_api = "responses"
requires_openai_auth = false
EOF

export APIEX_API_KEY="sk-xxxxxxxx"
codex

如果 `/responses` 报 404，优先检查 `wire_api = "responses"` 和 Base URL，不要把完整接口路径写进 `base_url`。

Cursor 接入

打开 Cursor 设置，进入 Models。
添加自定义模型，模型 ID 使用模型广场中的 `provider/model` 格式。
打开 OpenAI API Key 开关，填写 apiex Key。
Base URL 填写 `https://apiex.ai/v1` 或工具指定的 OpenAI 兼容端点。
保存后在 Chat、Composer 或 Agent 中选择对应模型。

Claude Code 接入

如果使用 Claude Code 的 IDE 或终端能力，可通过环境变量临时接入。

claude.env

export ANTHROPIC_BASE_URL="https://apiex.ai/anthropic"
export ANTHROPIC_API_KEY="sk-xxxxxxxx"

claude

团队协作时建议把结构化配置提交到仓库，把真实密钥放进本地 `.local` 配置或系统密钥管理中。

Claude Desktop 接入

桌面客户端接入通常通过本地 MCP 或工具代理完成。建议把 apiex Key 放在本机环境变量中，再由工具配置读取。

desktop.env

export APIEX_API_KEY="sk-xxxxxxxx"
export APIEX_BASE_URL="https://apiex.ai/v1"

如果客户端仍连接官方域名，检查工具配置是否读取了旧的环境变量或本地缓存。

Hermes / QClaw / AutoClaw 接入

这类 Agent 工具通常支持 OpenAI 兼容配置。核心字段保持一致：

API Key	`APIEX_API_KEY` 或工具支持的自定义环境变量。
Base URL	`https://apiex.ai/v1`，如工具要求 Responses API，则使用 OpenAI 兼容端点。
模型 ID	使用模型广场中的 `provider/model-name` 格式。

API 参考

对话生成

POST /v1/chat/completions

Responses

POST /openai/v1/responses

模型列表

GET /v1/models

多模态接口

图像、视频和参考图生成能力会按模型能力逐步开放。不同模型可能按 token、图片张数、分辨率、视频时长或任务规格计费。

文本生成图像

输入提示词，返回图像任务结果。

参考图生成图像

上传参考图并指定生成要求。

视频生成

按模型支持的时长、分辨率和任务类型计费。

故障排除

401 / 鉴权失败	检查 Key 是否正确、是否过期、是否有可用余额；确认工具读取的是 apiex Key。
404 on URL	Base URL 不要写成完整 API 路径。SDK 配置 Base URL，接口路径由 SDK 自己拼接。
模型不存在	确认模型 ID 来自模型广场，优先使用 `provider/model-name` 格式。
仍连接官方域名	检查本机环境变量、IDE 设置、CLI 用户级配置和项目级配置是否存在旧值。
402 / 429	检查账户余额、预算限制、并发限制和调用频率。
npm 安装失败	通常是 npm registry 网络或权限问题，可临时切换镜像、修复全局目录权限后重试。