Skip to main content
POST
/
v1
/
images
/
edits
创建图像编辑
curl --request POST \
  --url https://model-api.skyengine.com.cn/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form [email protected] \
  --form 'prompt=在图片中添加一朵红色的玫瑰花' \
  --form image.0='@example-file' \
  --form image.1.items='@example-file' \
  --form mask='@example-file'
{
  "created": 1589478378,
  "background": "auto",
  "output_format": "png",
  "quality": "high",
  "size": "1024x1024",
  "data": [
    {
      "url": "https://oaidalleapiprodscus.blob.core.windows.net/private/org-xyz/user-abc/img-edited.png"
    }
  ],
  "usage": {
    "input_tokens": 18,
    "input_tokens_details": {
      "image_tokens": 5,
      "text_tokens": 13
    },
    "output_tokens": 1,
    "total_tokens": 19
  }
}

Authorizations

​
Authorization
string
header
required

OpenAI API密钥认证。在 Authorization HTTP Header 中包含您的 API-Key，格式为 Bearer {API_KEY}

Body

multipart/form-data
​
image
required

要编辑的图像。必须是支持的图像文件或图像数组。对于 gpt-image-1，每个图像应为 png、webp 或 jpg 文件，小于 50MB。最多可提供 16 个图像。对于 dall-e-2，只能提供一个图像，且应为正方形 png 文件，小于 4MB

​
prompt
string
required

描述所需图像的文本提示。dall-e-2 最大长度为 1000 个字符，gpt-image-1 最大长度为 32000 个字符

Maximum string length: 32000
Example:

"在图片中添加一朵红色的玫瑰花"

​
background
enum<string> | null
default:auto

设置生成图像背景的透明度。此参数仅支持 gpt-image-1。必须是 transparent、opaque 或 auto（默认值）之一。当使用 auto 时，模型将自动确定图像的最佳背景。如果是 transparent，输出格式需要支持透明度，因此应设置为 png（默认值）或 webp

Available options:
transparent,
opaque,
auto
​
input_fidelity
enum<string>
default:low

控制模型匹配输入图像的风格和特征（特别是面部特征）的努力程度。此参数仅支持 gpt-image-1。gpt-image-1-mini 不支持。支持 high 和 low，默认为 low

Available options:
high,
low
​
mask
file

一个额外的图像，其完全透明的区域（例如 alpha 为零的地方）指示应该编辑图像的位置。如果提供了多个图像，mask 将应用于第一个图像。必须是有效的 PNG 文件，小于 4MB，并且与图像具有相同的尺寸

​
model
enum<string> | null
default:dall-e-2

用于图像生成的模型。仅支持 dall-e-2 和 gpt-image-1。默认为 dall-e-2，除非使用特定于 gpt-image-1 的参数

Available options:
dall-e-2,
gpt-image-1
​
n
integer | null
default:1

要生成的图像数量。必须在 1 到 10 之间

Required range: 1 <= x <= 10
​
output_compression
integer | null
default:100

生成图像的压缩级别（0-100%）。此参数仅支持使用 webp 或 jpeg 输出格式的 gpt-image-1，默认为 100

Required range: 0 <= x <= 100
​
output_format
enum<string> | null
default:png

生成图像返回的格式。此参数仅支持 gpt-image-1。必须是 png、jpeg 或 webp 之一。默认值为 png

Available options:
png,
jpeg,
webp
​
partial_images
integer
default:0

要生成的部分图像数量。此参数用于返回部分图像的流式响应。值必须在 0 到 3 之间。当设置为 0 时，响应将是在一个流式事件中发送的单个图像。注意，如果完整图像生成得更快，最终图像可能会在生成完整数量的部分图像之前发送

Required range: 0 <= x <= 3
​
quality
enum<string> | null
default:auto

将要生成的图像质量。gpt-image-1 仅支持 high、medium 和 low。dall-e-2 仅支持 standard 质量。默认为 auto

Available options:
auto,
high,
medium,
low,
standard
​
response_format
enum<string> | null
default:url

生成图像的返回格式。必须是 url 或 b64_json 之一。URL 仅在生成图像后的 60 分钟内有效。此参数仅支持 dall-e-2，因为 gpt-image-1 始终返回 base64 编码的图像

Available options:
url,
b64_json
​
size
enum<string> | null
default:1024x1024

生成图像的尺寸。gpt-image-1 必须是 1024x1024、1536x1024（横向）、1024x1536（纵向）或 auto（默认值）之一。dall-e-2 必须是 256x256、512x512 或 1024x1024 之一

Available options:
1024x1024,
1536x1024,
1024x1536,
auto,
256x256,
512x512
​
stream
boolean | null
default:false

以流式模式编辑图像。默认为 false。有关更多信息，请参阅图像生成指南

​
user
string

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用

Response

图像编辑成功

​
created
integer<int64>
required

图像创建时的 Unix 时间戳（以秒为单位）

Example:

1677649963

​
data
object[]
required

生成的图像列表

​
background
enum<string>

用于图像生成的背景参数。transparent 或 opaque

Available options:
transparent,
opaque
​
output_format
enum<string>

图像生成的输出格式。png、webp 或 jpeg

Available options:
png,
webp,
jpeg
​
quality
enum<string>

生成图像的质量。low、medium 或 high

Available options:
low,
medium,
high
​
size
enum<string>

生成图像的尺寸。1024x1024、1024x1536 或 1536x1024

Available options:
1024x1024,
1024x1536,
1536x1024
​
usage
object

仅适用于 gpt-image-1，图像生成的 token 使用信息