图像
给定提示和/或输入图像,模型将生成新图像。
相关指南:图像生成
创建图像
post https://api.openai.com/v1/images/generations根据提示创建图像。
请求正文
| 参数 | 类型 | 必需 | 描述 | 
|---|---|---|---|
| prompt | string | 是 | 所需图像的文本描述。对于 dall-e-2,最大长度为 1000 个字符,对于dall-e-3,最大长度为 4000 个字符。 | 
| model | string | 否 | 用于图像生成的模型。默认为 dall-e-2。 | 
| n | integer or null | 否 | 要生成的图像数量。必须在 1 和 10 之间。对于 dall-e-3,仅支持n=1。默认为 1。 | 
| quality | string | 否 | 将要生成的图像的质量。 hd会创建具有更细致细节和更大一致性的图像。此参数仅适用于dall-e-3。默认为standard。 | 
| response_format | string or null | 否 | 生成的图像所使用的格式。必须是 url或b64_json之一。URL 在图像生成后 60 分钟内有效。默认为url。 | 
| size | string or null | 否 | 生成的图像的大小。对于 dall-e-2,必须是256x256、512x512或1024x1024之一。对于dall-e-3模型,必须是1024x1024、1792x1024或1024x1792之一。默认为1024x1024。 | 
| style | string or null | 否 | 生成的图像的风格。必须是 vivid或natural之一。Vivid 会使模型倾向于生成超现实和夸张的图像。Natural 会使模型生成更自然、更少超现实的图像。此参数仅适用于dall-e-3。默认为vivid。 | 
| user | string | 否 | 表示您的端用户的唯一标识符,可以帮助 OpenAI 监视和检测滥用。[了解更多信息](/docs/guides/safety-best-practices/end-user-ids | 
curl https://api.openai.com/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "dall-e-3",
    "prompt": "A cute baby sea otter",
    "n": 1,
    "size": "1024x1024"
  }'
响应:
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
创建图像编辑
POST https://api.openai.com/v1/images/edits
给定原始图像和提示,创建编辑或扩展的图像。
请求正文
| 参数 | 类型 | 必需 | 描述 | 
|---|---|---|---|
| 图像 | 文件 | 是 | 要编辑的图像。必须是有效的PNG文件,小于4MB,且方形。如果未提供掩码,则图像必须具有透明度,该透明度将用作掩码。 | 
| 提示 | 字符串 | 是 | 所需图像(s)的文本描述。最大长度为1000个字符。 | 
| 掩码 | 文件 | 否 | 其完全透明的区域(例如,alpha为零)指示应在其中编辑“图像”的附加图像。必须是有效的PNG文件,小于4MB,并且与“图像”具有相同的维度。 | 
| 模型 | 字符串 | 否 | 要使用的图像生成模型。目前仅支持“dall-e-2”。 默认为“dall-e-2”。 | 
| n | 整数或空值 | 否 | 要生成的图像数量。必须在1和10之间。 默认为1。 | 
| 大小 | 字符串或空值 | 否 | 所生成图像的大小。必须是“256x256”、“512x512”或“1024x1024”之一。 默认为“1024x1024”。 | 
| response_format | 字符串或空值 | 否 | 所生成图像的返回格式。必须是“url”或“b64_json”之一。 URL在图像生成后60分钟内有效。 默认为“url”。 | 
| 用户 | 字符串 | 否 | 表示您的端用户的唯一标识符,该标识符可以帮助OpenAI监视和检测滥用。 了解更多信息。 | 
返回
返回图像对象的列表。
示例请求
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"
响应
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
以下是上述HTML内容转译成Markdown格式的中文版本:
创建图像变体
请求地址
POST https://api.openai.com/v1/images/variations
简介
创建给定图像的一个或多个变体。
请求体参数
- image (必须, 文件): 用作变体基础的图像。必须是有效的PNG文件,大小不超过4MB,且为正方形。
- model (可选, 字符串): 用于图像生成的模型。当前只支持 dall-e-2。默认值为dall-e-2。
- n (可选, 整数): 生成图像的数量。必须介于1到10之间。对于 dall-e-3,只支持n=1。默认值为1。
- response_format (可选, 字符串): 返回生成图像的格式。必须是 url或b64_json其中之一。URL在图像生成后60分钟内有效。默认值为url。
- size (可选, 字符串): 生成图像的大小。必须是 256x256,512x512或1024x1024其中之一。默认值为1024x1024。
- user (可选, 字符串): 表示您的终端用户的唯一标识符,可帮助OpenAI监控和检测滥用情况。了解更多。
返回
返回一系列image对象。
示例请求
curl https://api.openai.com/v1/images/variations \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -F image="@otter.png" \
  -F n=2 \
  -F size="1024x1024"
响应
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
图像对象
描述
表示由OpenAI API生成的图像的URL或内容。
参数
- b64_json (字符串): 如果 response_format是b64_json,则为生成图像的base64编码的JSON。
- url (字符串): 如果 response_format是url(默认),则为生成图像的URL。
- revised_prompt (字符串): 如果提示进行了修订,用于生成图像的提示。
示例对象
{
  "url": "...",
  "revised_prompt": "..."
}