HouYunFei Codex commited on
Commit ·
a06335e
1
Parent(s): c395cce
docs: update feature support and local compose
Browse filesCo-Authored-By: Codex <noreply@openai.com>
- README.md +27 -20
- docker-compose.local.yml +12 -0
- docs/feature-status.en.md +8 -7
README.md
CHANGED
|
@@ -36,16 +36,19 @@ docker compose up -d
|
|
| 36 |
- 兼容 `POST /v1/images/edits` 图片编辑接口
|
| 37 |
- 兼容面向图片场景的 `POST /v1/chat/completions`
|
| 38 |
- 兼容面向图片场景的 `POST /v1/responses`
|
| 39 |
-
- `GET /v1/models` 返回 `gpt-image-
|
|
|
|
| 40 |
- 支持通过 `n` 返回多张生成结果
|
|
|
|
| 41 |
|
| 42 |
### 在线画图功能
|
| 43 |
|
| 44 |
- 内置在线画图工作台,支持生成、图片编辑与多图组图编辑
|
| 45 |
-
- 支持 `gpt-image-
|
| 46 |
- 编辑模式支持参考图上传
|
| 47 |
- 前端支持多图生成交互
|
| 48 |
- 本地保存图片会话历史,支持回看、删除和清空
|
|
|
|
| 49 |
|
| 50 |
### 号池管理功能
|
| 51 |
|
|
@@ -60,7 +63,7 @@ docker compose up -d
|
|
| 60 |
|
| 61 |
### 实验性 / 规划中
|
| 62 |
|
| 63 |
-
- `
|
| 64 |
- 详细状态说明见:[功能清单](./docs/feature-status.en.md)
|
| 65 |
|
| 66 |
## Screenshots
|
|
@@ -73,7 +76,7 @@ docker compose up -d
|
|
| 73 |
|
| 74 |

|
| 75 |
|
| 76 |
-
Cherry Studio 中使用:
|
| 77 |
|
| 78 |

|
| 79 |
|
|
@@ -81,6 +84,10 @@ Cherry Studio 中使用:
|
|
| 81 |
|
| 82 |

|
| 83 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
## API
|
| 85 |
|
| 86 |
所有 AI 接口都需要请求头:
|
|
@@ -104,10 +111,10 @@ curl http://localhost:8000/v1/models \
|
|
| 104 |
<summary>说明</summary>
|
| 105 |
<br>
|
| 106 |
|
| 107 |
-
| 字段 | 说明
|
| 108 |
-
|:-----|:-----------------------------------------|
|
| 109 |
-
| 返回模型 |
|
| 110 |
-
|
|
| 111 |
|
| 112 |
<br>
|
| 113 |
</details>
|
|
@@ -124,7 +131,7 @@ curl http://localhost:8000/v1/images/generations \
|
|
| 124 |
-H "Content-Type: application/json" \
|
| 125 |
-H "Authorization: Bearer <auth-key>" \
|
| 126 |
-d '{
|
| 127 |
-
"model": "gpt-image-
|
| 128 |
"prompt": "一只漂浮在太空里的猫",
|
| 129 |
"n": 1,
|
| 130 |
"response_format": "b64_json"
|
|
@@ -137,7 +144,7 @@ curl http://localhost:8000/v1/images/generations \
|
|
| 137 |
|
| 138 |
| 字段 | 说明 |
|
| 139 |
|:------------------|:---------------------------------------------------|
|
| 140 |
-
| `model` | 图片模型,当前可用值以 `/v1/models` 返回结果为准,推荐使用 `gpt-image-
|
| 141 |
| `prompt` | 图片生成提示词 |
|
| 142 |
| `n` | 生成数量,当前后端限制为 `1-4` |
|
| 143 |
| `response_format` | 当前请求模型中包含该字段,默认值为 `b64_json` |
|
|
@@ -155,7 +162,7 @@ OpenAI 兼容图片编辑接口,用于上传图片并生成编辑结果。
|
|
| 155 |
```bash
|
| 156 |
curl http://localhost:8000/v1/images/edits \
|
| 157 |
-H "Authorization: Bearer <auth-key>" \
|
| 158 |
-
-F "model=gpt-image-
|
| 159 |
-F "prompt=把这张图改成赛博朋克夜景风格" \
|
| 160 |
-F "n=1" \
|
| 161 |
-F "image=@./input.png"
|
|
@@ -167,7 +174,7 @@ curl http://localhost:8000/v1/images/edits \
|
|
| 167 |
|
| 168 |
| 字段 | 说明 |
|
| 169 |
|:---------|:------------------------------------|
|
| 170 |
-
| `model` | 图片模型,
|
| 171 |
| `prompt` | 图片编辑提示词 |
|
| 172 |
| `n` | 生成数量,当前后端限制为 `1-4` |
|
| 173 |
| `image` | 需要编辑的图片文件,使用 multipart/form-data 上传 |
|
|
@@ -187,7 +194,7 @@ curl http://localhost:8000/v1/chat/completions \
|
|
| 187 |
-H "Content-Type: application/json" \
|
| 188 |
-H "Authorization: Bearer <auth-key>" \
|
| 189 |
-d '{
|
| 190 |
-
"model": "gpt-image-
|
| 191 |
"messages": [
|
| 192 |
{
|
| 193 |
"role": "user",
|
|
@@ -202,12 +209,12 @@ curl http://localhost:8000/v1/chat/completions \
|
|
| 202 |
<summary>字段说明</summary>
|
| 203 |
<br>
|
| 204 |
|
| 205 |
-
| 字段 | 说明
|
| 206 |
-
|:-----------|:------------------
|
| 207 |
-
| `model` | 图片模型,默认按图片生成场景处理
|
| 208 |
-
| `messages` | 消息数组,需要是图片相关请求内容
|
| 209 |
-
| `n` | 生成数量,按当前实现解析为图片数量
|
| 210 |
-
| `stream` |
|
| 211 |
|
| 212 |
<br>
|
| 213 |
</details>
|
|
@@ -243,7 +250,7 @@ curl http://localhost:8000/v1/responses \
|
|
| 243 |
| `model` | 响应中会回显该模型字段,但图片生成当前仍走图片生成兼容逻辑 |
|
| 244 |
| `input` | 输入内容,需要能解析出图片生成提示词 |
|
| 245 |
| `tools` | 必须包含 `image_generation` 工具请求 |
|
| 246 |
-
| `stream` |
|
| 247 |
|
| 248 |
<br>
|
| 249 |
</details>
|
|
|
|
| 36 |
- 兼容 `POST /v1/images/edits` 图片编辑接口
|
| 37 |
- 兼容面向图片场景的 `POST /v1/chat/completions`
|
| 38 |
- 兼容面向图片场景的 `POST /v1/responses`
|
| 39 |
+
- `GET /v1/models` 返回 `gpt-image-2`、`codex-gpt-image-2`、`auto`、`gpt-5`、`gpt-5-1`、`gpt-5-2`、`gpt-5-3`、`gpt-5-3-mini`、
|
| 40 |
+
`gpt-5-mini`
|
| 41 |
- 支持通过 `n` 返回多张生成结果
|
| 42 |
+
- 支持 Codex 中的画图接口逆向,仅 `Plus` / `Team` / `Pro` 订阅可用,模型别名为 `codex-gpt-image-2`,如有需要可自行在其他场景映射回 `gpt-image-2`,用于和官网画图区分;也就意味着同一账号会同时有官网和 Codex 两份生图额度
|
| 43 |
|
| 44 |
### 在线画图功能
|
| 45 |
|
| 46 |
- 内置在线画图工作台,支持生成、图片编辑与多图组图编辑
|
| 47 |
+
- 支持 `gpt-image-2`、`codex-gpt-image-2`、`auto`、`gpt-5`、`gpt-5-1`、`gpt-5-2`、`gpt-5-3`、`gpt-5-3-mini`、`gpt-5-mini` 模型选择
|
| 48 |
- 编辑模式支持参考图上传
|
| 49 |
- 前端支持多图生成交互
|
| 50 |
- 本地保存图片会话历史,支持回看、删除和清空
|
| 51 |
+
- 支持服务端缓存图片URL
|
| 52 |
|
| 53 |
### 号池管理功能
|
| 54 |
|
|
|
|
| 63 |
|
| 64 |
### 实验性 / 规划中
|
| 65 |
|
| 66 |
+
- `/v1/complete` 文本补全与流式输出已实现,但仍在测试,目前会出现对话重复的问题,请谨慎测试使用
|
| 67 |
- 详细状态说明见:[功能清单](./docs/feature-status.en.md)
|
| 68 |
|
| 69 |
## Screenshots
|
|
|
|
| 76 |
|
| 77 |

|
| 78 |
|
| 79 |
+
Cherry Studio 中使用,支持作为绘图接口接入:
|
| 80 |
|
| 81 |

|
| 82 |
|
|
|
|
| 84 |
|
| 85 |

|
| 86 |
|
| 87 |
+
New Api 接入:
|
| 88 |
+
|
| 89 |
+

|
| 90 |
+
|
| 91 |
## API
|
| 92 |
|
| 93 |
所有 AI 接口都需要请求头:
|
|
|
|
| 111 |
<summary>说明</summary>
|
| 112 |
<br>
|
| 113 |
|
| 114 |
+
| 字段 | 说明 |
|
| 115 |
+
|:-----|:-----------------------------------------------------------------------------------------------------------|
|
| 116 |
+
| 返回模型 | `gpt-image-2`、`codex-gpt-image-2`、`auto`、`gpt-5`、`gpt-5-1`、`gpt-5-2`、`gpt-5-3`、`gpt-5-3-mini`、`gpt-5-mini` |
|
| 117 |
+
| 接入场景 | 可接入 Cherry Studio、New API 等上游或客户端 |
|
| 118 |
|
| 119 |
<br>
|
| 120 |
</details>
|
|
|
|
| 131 |
-H "Content-Type: application/json" \
|
| 132 |
-H "Authorization: Bearer <auth-key>" \
|
| 133 |
-d '{
|
| 134 |
+
"model": "gpt-image-2",
|
| 135 |
"prompt": "一只漂浮在太空里的猫",
|
| 136 |
"n": 1,
|
| 137 |
"response_format": "b64_json"
|
|
|
|
| 144 |
|
| 145 |
| 字段 | 说明 |
|
| 146 |
|:------------------|:---------------------------------------------------|
|
| 147 |
+
| `model` | 图片模型,当前可用值以 `/v1/models` 返回结果为准,推荐使用 `gpt-image-2` |
|
| 148 |
| `prompt` | 图片生成提示词 |
|
| 149 |
| `n` | 生成数量,当前后端限制为 `1-4` |
|
| 150 |
| `response_format` | 当前请求模型中包含该字段,默认值为 `b64_json` |
|
|
|
|
| 162 |
```bash
|
| 163 |
curl http://localhost:8000/v1/images/edits \
|
| 164 |
-H "Authorization: Bearer <auth-key>" \
|
| 165 |
+
-F "model=gpt-image-2" \
|
| 166 |
-F "prompt=把这张图改成赛博朋克夜景风格" \
|
| 167 |
-F "n=1" \
|
| 168 |
-F "image=@./input.png"
|
|
|
|
| 174 |
|
| 175 |
| 字段 | 说明 |
|
| 176 |
|:---------|:------------------------------------|
|
| 177 |
+
| `model` | 图片模型, `gpt-image-2` |
|
| 178 |
| `prompt` | 图片编辑提示词 |
|
| 179 |
| `n` | 生成数量,当前后端限制为 `1-4` |
|
| 180 |
| `image` | 需要编辑的图片文件,使用 multipart/form-data 上传 |
|
|
|
|
| 194 |
-H "Content-Type: application/json" \
|
| 195 |
-H "Authorization: Bearer <auth-key>" \
|
| 196 |
-d '{
|
| 197 |
+
"model": "gpt-image-2",
|
| 198 |
"messages": [
|
| 199 |
{
|
| 200 |
"role": "user",
|
|
|
|
| 209 |
<summary>字段说明</summary>
|
| 210 |
<br>
|
| 211 |
|
| 212 |
+
| 字段 | 说明 |
|
| 213 |
+
|:-----------|:------------------|
|
| 214 |
+
| `model` | 图片模型,默认按图片生成场景处理 |
|
| 215 |
+
| `messages` | 消息数组,需要是图片相关请求内容 |
|
| 216 |
+
| `n` | 生成数量,按当前实现解析为图片数量 |
|
| 217 |
+
| `stream` | 已实现,但仍在测试 |
|
| 218 |
|
| 219 |
<br>
|
| 220 |
</details>
|
|
|
|
| 250 |
| `model` | 响应中会回显该模型字段,但图片生成当前仍走图片生成兼容逻辑 |
|
| 251 |
| `input` | 输入内容,需要能解析出图片生成提示词 |
|
| 252 |
| `tools` | 必须包含 `image_generation` 工具请求 |
|
| 253 |
+
| `stream` | 已实现,但仍在测试 |
|
| 254 |
|
| 255 |
<br>
|
| 256 |
</details>
|
docker-compose.local.yml
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
services:
|
| 2 |
+
app:
|
| 3 |
+
build:
|
| 4 |
+
context: .
|
| 5 |
+
dockerfile: Dockerfile
|
| 6 |
+
image: chatgpt2api:local
|
| 7 |
+
container_name: chatgpt2api-local
|
| 8 |
+
ports:
|
| 9 |
+
- "8000:80"
|
| 10 |
+
volumes:
|
| 11 |
+
- ./data:/app/data
|
| 12 |
+
- ./config.json:/app/config.json:ro
|
docs/feature-status.en.md
CHANGED
|
@@ -8,10 +8,13 @@
|
|
| 8 |
| OpenAI 兼容 `POST /v1/images/edits` | ✅ | 已支持,可上传图片进行编辑。 |
|
| 9 |
| 面向图片工作流的 `POST /v1/chat/completions` | ✅ | 已支持图片相关请求。 |
|
| 10 |
| 面向图片工作流的 `POST /v1/responses` | ✅ | 已支持图片生成工具调用。 |
|
| 11 |
-
| `GET /v1/models` 接口 | ✅ | 当前返回 `gpt-image-
|
| 12 |
| 同时生成多张图片 | ✅ | 已支持,后端与前端都可进行多图生成。 |
|
| 13 |
| 前端图片工作台 | ✅ | 已支持图片生成、图片编辑、模型选择、历史记录与查看大图。 |
|
| 14 |
| 前端图片输入 / 参考图交互 | ✅ | 已支持参考图上传、预览、移除和编辑模式工作流。 |
|
|
|
|
|
|
|
|
|
|
| 15 |
| 账号池管理 | ✅ | 已支持列表、筛选、批量操作、导出、手动编辑、刷新和删除。 |
|
| 16 |
| 账号额度刷新与恢复时间同步 | ✅ | 已支持账号信息刷新,限流账号也会自动继续检查。 |
|
| 17 |
| 失效 Token 自动清理 | ✅ | 已支持自动移除失效 Token。 |
|
|
@@ -21,15 +24,13 @@
|
|
| 21 |
| `sub2api` 连接管理与账号浏览 | ✅ | 已支持 `sub2api` 服务器的新增、修改、删除、分组查询和 OpenAI OAuth 账号列表读取。 |
|
| 22 |
| `sub2api` 导入 | ✅ | 已支持勾选 `sub2api` 中的 OpenAI OAuth 账号,批量拉取 `access_token` 导入本地号池,并展示导入进度。 |
|
| 23 |
| Docker 自托管部署 | ✅ | 已支持 Docker Compose 部署,并提供多架构镜像。 |
|
| 24 |
-
|
|
| 25 |
-
| `gpt-image-1` 与 `gpt-image-2` 的能力区分 | ⚠️ | `gpt-image-2` 已可选,但目前仍处于灰度 / 实验状态。 |
|
| 26 |
-
| 兼容接口中的多参考图能力 | ⚠️ | 前端已支持多参考图交互,接口侧相关能力仍在完善中。 |
|
| 27 |
| 更高级的 Token 调度策略 | ⚠️ | 当前已有基础轮询与限流刷新机制,更复杂的调度策略仍在完善中。 |
|
| 28 |
| Render / Vercel 等部署表述 | ⚠️ | 当前主要以 Docker 部署为主,其他平台部署方式暂未重点说明。 |
|
| 29 |
-
| `/v1/complete` 文本补全与流式输出 |
|
| 30 |
-
| 流式输出支持 |
|
| 31 |
| 图片尺寸参数 | ❌ | 待实现。 |
|
| 32 |
-
| 服务端图片 URL 缓存 |
|
| 33 |
| `rt_token` 刷新 | ❌ | 待实现。 |
|
| 34 |
| 代理配置功能 | ✅ | 已支持网页端配置全局 HTTP / HTTPS / SOCKS5 / SOCKS5H 代理,并应用到出站请求。 |
|
| 35 |
| Anthropic 协议支持 | ❌ | 待实现。 |
|
|
|
|
| 8 |
| OpenAI 兼容 `POST /v1/images/edits` | ✅ | 已支持,可上传图片进行编辑。 |
|
| 9 |
| 面向图片工作流的 `POST /v1/chat/completions` | ✅ | 已支持图片相关请求。 |
|
| 10 |
| 面向图片工作流的 `POST /v1/responses` | ✅ | 已支持图片生成工具调用。 |
|
| 11 |
+
| `GET /v1/models` 接口 | ✅ | 当前返回 `gpt-image-2`、`codex-gpt-image-2`、`auto`、`gpt-5`、`gpt-5-1`、`gpt-5-2`、`gpt-5-3`、`gpt-5-3-mini`、`gpt-5-mini`。 |
|
| 12 |
| 同时生成多张图片 | ✅ | 已支持,后端与前端都可进行多图生成。 |
|
| 13 |
| 前端图片工作台 | ✅ | 已支持图片生成、图片编辑、模型选择、历史记录与查看大图。 |
|
| 14 |
| 前端图片输入 / 参考图交互 | ✅ | 已支持参考图上传、预览、移除和编辑模式工作流。 |
|
| 15 |
+
| Codex 画图接口逆向 | ✅ | 已支持,仅 `Plus` / `Team` / `Pro` 订阅可用,模型别名为 `codex-gpt-image-2`;如有需要可自行在其他场景映射回 `gpt-image-2`。这是 Codex 逆向链路,用于和官网画图区分,同一账号通常会同时支持官网和 Codex 两份生图额度。 |
|
| 16 |
+
| Cherry Studio 接入 | ✅ | 已支持作为绘图接口接入 Cherry Studio。 |
|
| 17 |
+
| New API 接入 | ✅ | 已支持接入 New API。 |
|
| 18 |
| 账号池管理 | ✅ | 已支持列表、筛选、批量操作、导出、手动编辑、刷新和删除。 |
|
| 19 |
| 账号额度刷新与恢复时间同步 | ✅ | 已支持账号信息刷新,限流账号也会自动继续检查。 |
|
| 20 |
| 失效 Token 自动清理 | ✅ | 已支持自动移除失效 Token。 |
|
|
|
|
| 24 |
| `sub2api` 连接管理与账号浏览 | ✅ | 已支持 `sub2api` 服务器的新增、修改、删除、分组查询和 OpenAI OAuth 账号列表读取。 |
|
| 25 |
| `sub2api` 导入 | ✅ | 已支持勾选 `sub2api` 中的 OpenAI OAuth 账号,批量拉取 `access_token` 导入本地号池,并展示导入进度。 |
|
| 26 |
| Docker 自托管部署 | ✅ | 已支持 Docker Compose 部署,并提供多架构镜像。 |
|
| 27 |
+
| 兼容接口中的多参考图能力 | ✅ | 已实现,支持在兼容接口中传入多参考图。 |
|
|
|
|
|
|
|
| 28 |
| 更高级的 Token 调度策略 | ⚠️ | 当前已有基础轮询与限流刷新机制,更复杂的调度策略仍在完善中。 |
|
| 29 |
| Render / Vercel 等部署表述 | ⚠️ | 当前主要以 Docker 部署为主,其他平台部署方式暂未重点说明。 |
|
| 30 |
+
| `/v1/complete` 文本补全与流式输出 | ✅ | 已实现。 |
|
| 31 |
+
| 流式输出支持 | ✅ | 已实现。 |
|
| 32 |
| 图片尺寸参数 | ❌ | 待实现。 |
|
| 33 |
+
| 服务端图片 URL 缓存 | ✅ | 已实现。 |
|
| 34 |
| `rt_token` 刷新 | ❌ | 待实现。 |
|
| 35 |
| 代理配置功能 | ✅ | 已支持网页端配置全局 HTTP / HTTPS / SOCKS5 / SOCKS5H 代理,并应用到出站请求。 |
|
| 36 |
| Anthropic 协议支持 | ❌ | 待实现。 |
|