API 接入OpenAI 协议
Image Edit
POST https://api.easyx.ai/v1/images/edits
Authorization: Bearer easyx_ws_xxx
Content-Type: multipart/form-data图片编辑
编辑请求使用 multipart/form-data,Content-Type 的 boundary 由 curl 自动生成。上传文件内容总计不能超过 64 MB,模型可能另有更小的单图限制。此接口不提供流式输出。
curl https://api.easyx.ai/v1/images/edits \
-H "Authorization: Bearer easyx_ws_xxx" \
-F "model=gpt-image-1" \
-F "image=@input.png" \
-F "prompt=给图中的小海獭戴上红色贝雷帽"多张参考图
curl https://api.easyx.ai/v1/images/edits \
-H "Authorization: Bearer easyx_ws_xxx" \
-F "model=gpt-image-1" \
-F "image[]=@product-a.png" \
-F "image[]=@product-b.png" \
-F "prompt=将两件商品放在同一个礼品篮里"蒙版编辑
curl https://api.easyx.ai/v1/images/edits \
-H "Authorization: Bearer easyx_ws_xxx" \
-F "model=gpt-image-1" \
-F "image=@input.png" \
-F "mask=@mask.png" \
-F "prompt=将遮罩选中的区域改成蓝色背景"编辑参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 图片编辑模型名称。 |
image / image[] | file / files | 是 | 输入图片。单图使用 image,多图模型可使用 image[]。 |
prompt | string | 是 | 修改指令。 |
mask | file | 否 | 蒙版图片,完全透明的区域表示需要修改的位置,具体支持情况随模型而不同。 |
n / size / quality | form fields | 否 | 与生成接口相同,支持情况由编辑模型决定。 |
输出格式、质量等通用选项见 Image Generation 参数。
响应
URL 结果
{
"created": 1741569952,
"data": [
{
"url": "https://example.com/generated-image.png",
"revised_prompt": "一只戴贝雷帽的小海獭。"
}
]
}Base64 结果
{
"created": 1741569952,
"data": [
{
"b64_json": "BASE64_IMAGE"
}
],
"usage": {
"input_tokens": 50,
"output_tokens": 100,
"total_tokens": 150
}
}成功响应
所有三个端点都返回包含图片对象列表的响应。
created
- 类型:整数
- 说明:响应创建的时间戳
data
- 类型:数组
- 说明:生成的图片对象列表
usage(部分模型返回)
- 类型:对象
- 说明:API 调用的 token 使用情况
total_tokens:使用的总 token 数input_tokens:输入使用的 token 数output_tokens:输出使用的 token 数input_tokens_details:输入 token 的详细信息(文本 token 和图像 token)
图片对象
b64_json
- 类型:字符串
- 说明:如果 response_format 为
b64_json,则包含生成图片的 base64 编码 JSON
url
- 类型:字符串
- 说明:如果 response_format 为
url(默认),则包含生成图片的 URL
revised_prompt
- 类型:字符串
- 说明:如果提示有任何修改,则包含用于生成图片的修改后的提示
示例图片对象:
{
"url": "https://...",
"revised_prompt": "一只可爱的小海獭在水中嬉戏,它有着圆圆的眼睛和毛茸茸的皮毛"
}读取图片结果
import base64
from pathlib import Path
# response is the parsed JSON response
for index, image in enumerate(response["data"]):
if image.get("b64_json"):
Path(f"image-{index}").write_bytes(base64.b64decode(image["b64_json"]))
elif image.get("url"):
print(image["url"])Python SDK
pip install openaifrom openai import OpenAI
client = OpenAI(api_key="easyx_ws_xxx", base_url="https://api.easyx.ai/v1")
with open("input.png", "rb") as image:
result = client.images.edit(
model="gpt-image-1",
image=image,
prompt="Give the sea otter a blue beret",
)
print(result.data)Node.js SDK
npm install openaiimport fs from "node:fs";
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "easyx_ws_xxx",
baseURL: "https://api.easyx.ai/v1",
});
const result = await client.images.edit({
model: "gpt-image-1",
image: fs.createReadStream("input.png"),
prompt: "Give the sea otter a blue beret",
});
console.log(result.data);