编辑图片

根据一张或多张输入图片和文本提示生成编辑结果，也可以使用遮罩指定需要修改的区域。

POST/v1/images/edits

根据一张或多张输入图片和文本提示创建编辑后的图片。提供遮罩时，遮罩中的透明区域表示需要编辑的位置；多图编辑时，遮罩应用于第一张输入图片。

输入文件类型、大小、数量、遮罩规则以及质量和尺寸选项取决于所选模型。请使用当前 API Key 可见且支持图片编辑的模型 ID。

Authorization

bearerAuth

AuthorizationBearer <token>

在 Authorization Header 中使用 Bearer your-api-key。

In: header

Request Body

multipart/form-data

使用 Multipart 提交图片、提示词和可选遮罩。客户端应由请求库自动生成 Content-Type 的 boundary。

TypeScript Definitions

Use the request body type in TypeScript.

image*|array<>

要编辑的一张或多张图片。DALL·E 2 接受小于 4 MB 的正方形 PNG；未提供 mask 时，图片需要包含透明区域。GPT-Image-1 可接受多张 PNG、WEBP 或 JPG，每张小于 25 MB。

实际支持的文件格式、大小和数量以所选模型为准。

prompt*string

期望的编辑结果。DALL·E 2 最多接受 1,000 个字符，GPT-Image-1 最多接受 32,000 个字符；其他模型的限制以其实际能力为准。

Length1 <= length

mask?file

可选遮罩图片。完全透明区域表示需要编辑的位置。遮罩应为小于 4 MB 的 PNG，并与输入图片尺寸相同；多图编辑时遮罩应用于第一张图片。

Formatbinary

model*string

要使用的图片编辑模型 ID。请选择当前 API Key 可见且支持图片编辑的模型。

Length1 <= length

n?integer|null

要返回的图片数量，取值范围为 1 到 10，实际支持数量取决于所选模型。

Range1 <= value <= 10

Default1

quality?string|null

图片质量。GPT-Image-1 支持 high、medium、low，DALL·E 2 使用 standard，默认值为 auto。

Default"auto"

Value in

"auto"
"high"
"medium"
"low"
"standard"
null

response_format?string|null

图片返回格式。url 返回图片地址，该地址在生成后 60 分钟内有效；b64_json 返回 Base64 编码图片数据。

Default"url"

Value in

"url"
"b64_json"
null

size?string|null

图片尺寸。GPT-Image-1 支持 1024x1024、1536x1024、1024x1536 和 auto，DALL·E 2 支持 256x256、512x512、1024x1024。

Default"1024x1024"

Value in

"256x256"
"512x512"
"1024x1024"
"1536x1024"
"1024x1536"
"auto"
null

user?string

代表最终用户的唯一标识符，可用于监控和检测滥用行为。

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/edits" \  -F model="MODEL_ID" \  -F image="otter.png" \  -F mask="mask.png" \  -F prompt="一只戴着贝雷帽的可爱小海獭" \  -F n="1" \  -F size="1024x1024"

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://example.com/edited-image-1.png"
    },
    {
      "url": "https://example.com/edited-image-2.png"
    }
  ]
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`