API 参考

编辑图像

以 multipart/form-data 上传原图与修改指令的图片编辑接口,可选遮罩图与流式返回。

端点 POST /v1/images/edits

与 OpenAI Images API 兼容,以 multipart/form-data 上传原图并给出修改指令。耗时与生成图像相当,客户端超时建议设为 300 秒。

请求

content-typemultipart/form-data,鉴权用 Authorization: Bearer sk-xxxxxx

参数

表单字段类型必填说明
modelstringgpt-image-2
image文件原图
promptstring修改指令
mask文件遮罩图,透明区域为可编辑区域,尺寸与原图一致
ninteger生成张数,默认 1
sizestring输出尺寸 宽x高,如 1024x1024;或 auto
qualitystringlowmediumhighauto
backgroundstringtransparentopaqueauto
input_fidelitystring对原图细节的保真程度,highlow
output_formatstringpng(默认)、jpegwebp
output_compressioninteger0 到 100,仅对 jpegwebp 生效
streamboolean设为 true 时以 SSE 流式返回。事件格式取决于上游渠道:多数情况与 生成图像 相同(image.generation.chunkimage.generation.result,以 [DONE] 结束);也可能是 OpenAI 原生事件,以 event: image_generation.completed 结束,结果图在该事件的 b64_json
partial_imagesinteger0 到 3
userstring调用方自定义的最终用户标识,原样透传

其余字段按 OpenAI Images API 格式透传。

响应

json
{
  "created": 1752345600,
  "data": [ { "b64_json": "iVBORw0KGgo..." } ],
  "size": "1024x1024",
  "quality": "…",
  "output_format": "png",
  "background": "…",
  "moderation": "…",
  "usage": { "…": "…" }
}
字段说明
data[].b64_jsonBase64 编码的结果图
size / quality / output_format / background / moderation本次实际生效的输出设置
usage本次请求的用量

createddata[].b64_json 每次都返回;sizequalityoutput_formatbackgroundmoderationusage 是否出现取决于本次调用的上游渠道,客户端按可选字段处理。实测 backgroundtransparent 时,编辑接口返回的图片不带透明通道。

示例

bash
curl https://caapi.top/v1/images/edits \
  -H "Authorization: Bearer sk-xxxxxx" \
  -F model="gpt-image-2" \
  -F image="@photo.png" \
  -F prompt="把背景换成星空"

错误

HTTP 状态error.type触发条件
401missing_auth_credential / invalid_api_key / invalid_bearer_token鉴权失败,详见 鉴权

50 篇文档。文中出现的模型名与价格以模型广场的实时数据为准。