API 文档
IT小哥 API 完全兼容 OpenAI API 协议。如果你已经用过 openai-python / openai-node 等 SDK,把 base_url 改一行即可切过来。当前主推 API 订阅:按有效期和周额度放行,不再要求用户先充值再按量扣费。
- 注册 / 登录后,在 用户中心购买 API 订阅,订阅会按周额度放行
- 进入 我的 API Key 创建一把
sk-*密钥 - 把 Base URL 改成
https://api.itxiaoge.com/v1,开始调用
| Base URL | https://api.itxiaoge.com/v1 |
| API Key | 从 我的 API Key 创建,sk-* 格式 |
| 额度方式 | API 订阅按周额度放行;加油包 60 天有效,总额度不按周重置 |
| 兼容协议 | OpenAI Chat Completions / Embeddings / Images 全兼容 |
| 支持模型 | GPT-5.5 / GPT-5 mini / Claude Sonnet 4.6 / Gemini 3 Pro / DeepSeek 等,实际以 /v1/models 为准 |
| 查看用量 | 在 控制台首页查看 API 订阅状态,在 API 使用明细查看调用记录 |
1 分钟示例
# 把 sk-xxx 替换为你自己的 key curl "https://api.itxiaoge.com/v1/chat/completions" \ -H "Authorization: Bearer sk-xxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-5.5", "messages": [{"role":"user","content":"你好"}] }'
from openai import OpenAI client = OpenAI( api_key="sk-xxxxxxxxxxxx", base_url="https://api.itxiaoge.com/v1", ) resp = client.chat.completions.create( model="gpt-5.5", messages=[{"role": "user", "content": "你好"}], ) print(resp.choices[0].message.content)
import OpenAI from "openai"; const client = new OpenAI({ apiKey: "sk-xxxxxxxxxxxx", baseURL: "https://api.itxiaoge.com/v1", }); const resp = await client.chat.completions.create({ model: "gpt-5.5", messages: [{ role: "user", content: "你好" }], }); console.log(resp.choices[0].message.content);
认证
每次请求通过 Authorization: Bearer <sk-xxx> 头传入你的 API Key。
Key 在 用户中心 → 我的 API Key 创建、启用、禁用、删除;完整 Key 只在创建时展示一次,请及时保存。
Base URL
所有 OpenAI 兼容端点都在 /v1 下:
https://api.itxiaoge.com/v1
https://itxiaoge.com/v1 目前也可兼容访问,但文档和代码示例建议统一使用独立 API 域名 api.itxiaoge.com。
Codex 配置 OpenAI 兼容
Codex 使用 OpenAI 兼容入口,Base URL 需要带 /v1。建议把 API Key 放在环境变量里,避免写进项目代码或仓库。
一键脚本
脚本会在本机提示输入 API Key,并写入本机环境变量,不会把 Key 上传到网页或服务器。
# macOS / Linux / Windows WSL,推荐先下载,确认内容后执行
curl -fsSLO https://itxiaoge.com/install-codex-itxiaoge.sh
chmod +x install-codex-itxiaoge.sh
./install-codex-itxiaoge.sh
# Windows PowerShell
iwr https://itxiaoge.com/install-codex-itxiaoge.ps1 -OutFile install-codex-itxiaoge.ps1
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\install-codex-itxiaoge.ps1
~/.codex/config.toml,保存 ITXG_API_KEY,最后测试 /v1/models 是否可访问。
临时配置
# macOS / Linux / WSL export ITXG_API_KEY="sk-xxxxxxxxxxxx" # 如果你的 Codex 版本支持 OPENAI_BASE_URL,可直接这样试用 export OPENAI_API_KEY="$ITXG_API_KEY" export OPENAI_BASE_URL="https://api.itxiaoge.com/v1" codex
推荐:写入 ~/.codex/config.toml
model = "gpt-5.5" model_provider = "itxiaoge" [model_providers.itxiaoge] name = "IT小哥 API" base_url = "https://api.itxiaoge.com/v1" env_key = "ITXG_API_KEY" wire_api = "chat" requires_openai_auth = false
然后启动前设置 Key:
export ITXG_API_KEY="sk-xxxxxxxxxxxx" codex
如果你的 Codex 版本不识别自定义 provider,先升级 Codex;不同版本对 OPENAI_BASE_URL 和 config.toml 的支持会有差异。
Claude Code 配置 Claude 兼容
Claude Code 走 Anthropic 风格接口。这里的 Base URL 不要带 /v1,Claude Code 会自己拼接请求路径。认证建议使用 ANTHROPIC_AUTH_TOKEN,它会生成 Authorization: Bearer sk-...,正好匹配 IT小哥 API Key 校验。
临时配置
# macOS / Linux / WSL export ANTHROPIC_BASE_URL="https://api.itxiaoge.com" export ANTHROPIC_AUTH_TOKEN="sk-xxxxxxxxxxxx" export ANTHROPIC_MODEL="claude-sonnet-4.6" claude
长期配置:~/.claude/settings.json
{
"env": {
"ANTHROPIC_BASE_URL": "https://api.itxiaoge.com",
"ANTHROPIC_AUTH_TOKEN": "sk-xxxxxxxxxxxx",
"ANTHROPIC_MODEL": "claude-sonnet-4.6",
"CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY": "1"
}
}
ANTHROPIC_BASE_URL填https://api.itxiaoge.com,不要写成https://api.itxiaoge.com/v1。- 不要使用
ANTHROPIC_API_KEY,它通常走X-Api-Key请求头;本站 API Key 校验使用 Bearer Token。 - 如果模型名不可用,先在控制台或通过
GET /v1/models查看当前上游可用模型。
Chat Completions 最常用
POST /v1/chat/completions — 和 OpenAI 完全一致。支持 stream:true 流式输出。
| 字段 | 类型 | 说明 |
|---|---|---|
model | string | 模型名,见 Models |
messages | array | 对话历史,{role, content} |
stream | bool | 是否流式返回,默认 false |
max_tokens | int | 最多输出多少 token |
temperature | float | 0–2,默认 1 |
tools / tool_choice | object | 函数调用,同 OpenAI 语义 |
Embeddings
POST /v1/embeddings — 文本向量化。
curl "https://api.itxiaoge.com/v1/embeddings" \
-H "Authorization: Bearer sk-xxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "text-embedding-3-small",
"input": "你好,世界"
}'
Images
POST /v1/images/generations — 文本生成图片。
curl "https://api.itxiaoge.com/v1/images/generations" \
-H "Authorization: Bearer sk-xxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "dall-e-3",
"prompt": "a cute cat",
"size": "1024x1024"
}'
可用模型
GET /v1/models — 返回当前上游可调用的全部模型。
常见模型(具体可用列表以 /v1/models 实时返回为准):
- OpenAI 系列:GPT-5.5 · GPT-5 mini 等
- Claude 系列:Claude Sonnet 4.6 · Claude Opus 4.5 等
- Gemini 系列:Gemini 3 Pro · Gemini 2.5 Pro 等
- DeepSeek 系列:DeepSeek V3.1 · DeepSeek Reasoner 等
提示:不同上游服务池的真实 model id 可能不同,生产环境请先调用 GET /v1/models 获取当前可用列表。
流式响应
请求体加 "stream": true,响应按 SSE(text/event-stream)逐块返回,每块是一个 JSON:
data: {"choices":[{"delta":{"content":"Hello"}}]}
data: {"choices":[{"delta":{"content":" world"}}]}
data: [DONE]
openai-python / openai-node SDK 自动处理。curl 需要加 -N 禁用 buffer。
订阅与额度
- 购买 API 订阅后,系统按订阅有效期和每周额度放行 API Key 调用。
- 当前套餐:轻享版每周 $10、入门版每周 $25、专业版每周 $60、工作室版每周 $150、团队版每周 $350、旗舰版每周 $600、企业版每周 $1000 API 额度。
- 加油包:¥100 到账 $200、¥240 到账 $500、¥388 到账 $900、¥588 到账 $1500、¥999 到账 $3000,60 天有效,用完为止。
- 周额度用量会按调用实际消耗统计,到达上限后返回
402 insufficient_quota。 - 历史余额兼容逻辑仍可保留给老用户,但新用户建议购买 API 订阅。
错误码
| HTTP | code | 含义 |
|---|---|---|
| 401 | invalid_auth | 没带 Authorization 头或 key 不存在 |
| 401 | invalid_key_prefix | key 必须以 sk- 开头 |
| 402 | insufficient_quota | 没有有效订阅、周额度不足,或老余额不足 |
| 403 | key_disabled | 该 key 已被禁用 |
| 502 | upstream_error | 上游通道出错,请稍后重试 |
| 503 | - | 暂无可用上游通道 |
FAQ
Q:原有代码怎么迁移?
A:只改两行 — api_key 换成你在用户中心创建的 sk-*,base_url 换成 https://api.itxiaoge.com/v1。
Q:API 订阅怎么计算?
A:按有效期和周额度放行。比如专业版是 30 天有效、每周 $60 API 额度,用完本周额度后需要等下周重置或升级套餐。
Q:能限制单 Key 可用的模型吗?
A:暂不支持,计划下个版本加模型白名单功能。
Q:支持流式?函数调用?图片 vision?
A:都支持,格式与 OpenAI 完全一致。