# OpenAI Image Edit

OpenAI 图片编辑协议，需要使用 Multipart 上传原图。

## 接口与鉴权

`POST https://api.tu-zi.com/v1/images/edits`

传输方式: multipart

使用模型调用 API Key。示例凭证为占位符，请从环境变量读取真实密钥。

```http
Authorization: Bearer YOUR_API_KEY
```

## 请求体参数

| 字段 | 类型 | 必填 | 说明与约束 |
| --- | --- | --- | --- |
| model | string | 是 | 要调用的图片编辑模型。 |
| image | file | 是 | 需要编辑的原始图片。 |
| mask | file | 否 | 可选 PNG 遮罩；透明区域表示需要编辑的位置。 |
| prompt | string | 是 | 图片编辑指令。 示例: 保留主体，将背景替换为晴朗海滩。 |
| size | string | 否 | 输出图片尺寸。 表单初始值（非上游默认值）: "1024x1024" 可选值: "1024x1024", "1536x1024", "1024x1536" |
| n | integer | 否 | 生成图片数量。 表单初始值（非上游默认值）: 1 定义范围: 1 ~ 10 |

## 最小请求示例

```json
{
  "model": "YOUR_MODEL",
  "prompt": "Add a blue background",
  "image": "@input.png"
}
```

## 运行前准备

将 https://api.tu-zi.com 替换为本站地址（不要重复追加 /v1），YOUR_MODEL 替换为模型广场中的完整模型名。Python 示例需要先安装 requests；JavaScript 示例使用 Node.js 20+ 并保存为 .mjs 文件。WebSocket 示例按代码注释安装专用依赖。

先在本站令牌页面创建模型调用密钥，并设置 API_KEY 环境变量；cURL 中的 YOUR_API_KEY 需要替换。上传示例中的 input.png/input.wav 是本地文件，必须提前准备。

首次运行使用最小请求；成功后对照下方响应字段读取结果。异步接口返回任务 ID 后仍需查询，任务提交成功不代表生成已完成。

## 代码示例

### curl

```bash
curl --request POST 'https://api.tu-zi.com/v1/images/edits' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --form 'model=YOUR_MODEL' \
  --form 'prompt=Add a blue background' \
  --form 'image=@input.png'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/v1/images/edits"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
from contextlib import ExitStack
data = json.loads("{\"model\":\"YOUR_MODEL\",\"prompt\":\"Add a blue background\"}")
with ExitStack() as stack:
    files = {}
    files["image"] = stack.enter_context(open("input.png", "rb"))
    response = requests.request("POST", url, headers=headers, data=data, files=files, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
import { readFile } from 'node:fs/promises';
// Node.js 20+
const url = "https://api.tu-zi.com/v1/images/edits";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const body = new FormData();
body.append("model", "YOUR_MODEL");
body.append("prompt", "Add a blue background");
body.append("image", new Blob([await readFile("input.png")]), "input.png");
const response = await fetch(url, { method: "POST", headers, body });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## 响应字段

| 字段 | 类型 | 说明与约束 |
| --- | --- | --- |
| data[].url | string | 图片链接（URL 输出模式）。 |
| data[].b64_json | string | Base64 图片（支持该输出模式时）。 |

以下为示例响应，部分接口仅展示主要字段；可选字段不保证出现。

```json
{
  "created": 1793491200,
  "data": [
    {
      "url": "https://example.com/result.png"
    }
  ]
}
```

## 错误处理与重试

检查 HTTP 状态与该协议的错误对象；不要将不同协议的错误字段混用。401/403 检查凭证与权限，429 退避等待，5xx 检查网关或上游状态。错误正文可能含 error/message/code 等字段，以实际协议为准。

查询可采用有上限的指数退避；创建任务、生成内容、创建或删除密钥等操作不要盲目重试，以免重复计费或重复执行。

## 适用限制

本页是协议基础结构。模型可用参数、枚举、上限和异步行为以该模型“快速上手”为准；示例中的 YOUR_MODEL 必须替换。表中表单初始值不代表上游默认值。 同步响应必须逐项检查 data[]：url 为图片下载地址；b64_json 是图片字节的 Base64 编码，需解码后保存，不能把 Base64 字符串当 URL。不要假定只返回第一种格式，也不要把 HTTP 200、空 data[] 或只有文字当作图片生成成功。下载结果链接时不要携带本站 API Key；根据实际图片格式/MIME 保存并校验文件，不能仅改扩展名来转换格式。 image=@input.png 是 cURL 的本地文件上传语法；Python 使用 files，JavaScript 使用 FormData/Blob。不要把 @input.png 或本地文件路径作为 JSON 字符串发送。multipart 的 Content-Type/boundary 由客户端库生成，不手写 application/json。多图、mask、尺寸和输出格式只在当前模型参数明确支持时使用。

## 文档依据

定义版本: 1

审核日期: 2026-11-02

来源: https://api.tu-zi.com/docs/api/reference-relay-image-edit

关联协议说明: https://api.tu-zi.com/docs/api/images

本文只包含接口文档和示例。真实密钥、账号数据及用户请求内容不包含在复制内容中。