API文档(api-reference)
图片(Images)

图像Images

给定提示和/或输入图像,模型将生成一张新图像。

相关指南:图像生成

图像生成Create image Beta

post https://api.openai.com/v1/images/generations (opens in a new tab)

基于提示创建图像。

请求正文

prompt 是字符串类型的必填项,表示所需图像的文本描述。最大长度为1000个字符。

n 是整数类型的可选项。默认为 1。表示要生成的图像数,必须介于 1 和 10 之间。

size 是字符串类型的可选项。默认为 1024x1024。表示所生成图像的大小。必须是 256x256512x5121024x1024 中的一种。

response_format 是字符串类型的可选项。默认为 url。表示生成的图像返回的格式,必须是 urlb64_json 中的一种。

user 是字符串类型的可选项,表示您最终用户的唯一标识符,有助于 OpenAI 监测和检测滥用。

了解更多信息

请求示例(Python方式)

 curl https://api.openai.com/v1/images/generations 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer $OPENAI_API_KEY" 
  -d '{
    "prompt": "A cute baby sea otter",
    "n": 2,
    "size": "1024x1024"
  }'

请求参数(Parameters)

 {
 "prompt": "A cute baby sea otter",
 "n": 2,
 "size": "1024x1024"
}

响应体 (Response)

{
 "created": 1589478378,
 "data": [
    {
 "url": "https://..."
    },
    {
 "url": "https://..."
    }
  ]
}

创建编辑或扩展的图像 Create image editBeta

post https://api.openai.com/v1/images/edits (opens in a new tab)

基于原始图像和提示,创建编辑或扩展的图像。

请求正文

image 字符串类型,必填项。要编辑的图像。必须是有效的PNG文件,小于4MB且正方形。如果未提供掩码,则图像必须具有透明度,将用作掩码。

mask 字符串类型,可选。额外的图片,其完全透明区域(例如alpha值为0)表示需要编辑 image 的位置。必须是有效的 PNG 文件,不超过 4MB,且与 image 具有相同的尺寸。

prompt 字符串类型,必填项。所需图片的文本描述。最大长度为1000个字符。

n 整数类型,可选。默认是 1。要生成的图片数量。必须介于 1 和 10 之间。

size 字符串类型,可选。默认是 1024x1024。生成图片的尺寸。必须是 256x256512x5121024x1024 中的一个。

response_format 字符串类型,可选。默认是 url。返回生成的图片的格式。必须是 urlb64_json 中的一个。

user 字符串类型,可选。表示您的终端用户的唯一标识符,可以帮助OpenAI监视和检测滥用。了解更多

请求示例(Python方式)

curl https://api.openai.com/v1/images/edits 
  -H "Authorization: Bearer $OPENAI_API_KEY" 
  -F image="@otter.png" 
  -F mask="@mask.png" 
  -F prompt="A cute baby sea otter wearing a beret" 
  -F n=2 
  -F size="1024x1024"

响应体 (Response)

{
 "created": 1589478378,
 "data": [
    {
 "url": "https://..."
    },
    {
 "url": "https://..."
    }
  ]
}

创建给定图像 Create image variationBeta

post https://api.openai.com/v1/images/variations (opens in a new tab)

创建给定图像的变化。

请求体

image 字符串类型,必填项。用作变化基础的图片。必须是有效的 PNG 文件,小于 4MB 并且是正方形的。

n 整数类型,可选。默认是 1。要生成的图片数量。必须介于 1 和 10 之间。

size 字符串类型,可选。默认是 1024x1024。生成图片的尺寸。必须是 256x256512x5121024x1024 中的一个。

response_format 字符串类型,可选。默认是 url。返回生成的图片的格式。必须是 urlb64_json 中的一个。

user 字符串类型,可选。表示您的终端用户的唯一标识符,可以帮助OpenAI监视和检测滥用。了解更多

请求示例(Python方式)

 curl https://api.openai.com/v1/images/variations 
  -H "Authorization: Bearer $OPENAI_API_KEY" 
  -F image="@otter.png" 
  -F n=2 
  -F size="1024x1024"

响应体 (Response)

{
 "created": 1589478378,
 "data": [
    {
 "url": "https://..."
    },
    {
 "url": "https://..."
    }
  ]
}