OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

图像

给定提示和/或输入图像，模型将生成新图像。相关指南：图像生成 source

创建镜像

POST https://api.openai.com/v1/images/generations

在给定提示的情况下创建图像。source

请求正文

提示

字符串source

必填

所需图像的文本描述。的最大长度为 1000 个字符dall-e-2和 4000 个字符dall-e-3.source

MODEL

字符串source

可选

默认为 dall-e-2

用于图像生成的模型。source

整数或 nullsource

可选

默认为 1

要生成的图像数。必须介于 1 和 10 之间。为dall-e-3只n=1受支持。source

质量

字符串source

可选

默认为 standard

将生成的图像质量。hd创建的图像具有更精细的细节和更高的图像一致性。此参数仅支持dall-e-3.source

response_format

string 或 nullsource

可选

默认为 url

返回生成图像的格式。必须是以下之一url或b64_json.URL 仅在图像生成后的 60 分钟内有效。source

大小

string 或 nullsource

可选

默认为 1024x1024

生成的图像的大小。必须是以下之一256x256,512x512或1024x1024为dall-e-2.必须是以下之一1024x1024,1792x1024或1024x1792为dall-e-3模型。source

风格

string 或 nullsource

可选

默认为 vivid

生成的图像的样式。必须是以下之一vivid或natural.Vivid 使模型倾向于生成超真实和戏剧性的图像。自然使模型生成更自然、外观更不真实的图像。此参数仅支持dall-e-3.source

用户

字符串source

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多。source

返回图像对象列表。source

示例请求

1
2
3
4
5
6
7
8
9
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"
  }'

1
2
3
4
5
6
7
8
9
from openai import OpenAI
client = OpenAI()

client.images.generate(
  model="dall-e-3",
  prompt="A cute baby sea otter",
  n=1,
  size="1024x1024"
)

1
2
3
4
5
6
7
8
9
10
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const image = await openai.images.generate({ model: "dall-e-3", prompt: "A cute baby sea otter" });

  console.log(image.data);
}
main();

响应

1
2
3
4
5
6
7
8
9
10
11
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

创建图像编辑

POST https://api.openai.com/v1/images/edits

在给定原始图像和提示的情况下创建已编辑或扩展的图像。source

请求正文

图像

文件source

必填

要编辑的图像。必须是有效的 PNG 文件，大小小于 4MB，并且是正方形。如果未提供 mask，则图像必须具有透明度，该透明度将用作 mask。source

提示

字符串source

必填

所需图像的文本描述。最大长度为 1000 个字符。source

遮罩

文件source

可选

其完全透明区域（例如 alpha 为零）的附加图像指示image应该编辑。必须是有效的 PNG 文件，小于 4MB，并且尺寸与image.source

MODEL

字符串source

可选

默认为 dall-e-2

用于图像生成的模型。只dall-e-2目前支持。source

整数或 nullsource

可选

默认为 1

要生成的图像数。必须介于 1 和 10 之间。source

大小

string 或 nullsource

可选

默认为 1024x1024

生成的图像的大小。必须是以下之一256x256,512x512或1024x1024.source

response_format

string 或 nullsource

可选

默认为 url

返回生成图像的格式。必须是以下之一url或b64_json.URL 仅在图像生成后的 60 分钟内有效。source

用户

字符串source

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多。source

返回图像对象列表。source

示例请求

1
2
3
4
5
6
7
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"

1
2
3
4
5
6
7
8
9
10
from openai import OpenAI
client = OpenAI()

client.images.edit(
  image=open("otter.png", "rb"),
  mask=open("mask.png", "rb"),
  prompt="A cute baby sea otter wearing a beret",
  n=2,
  size="1024x1024"
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import fs from "fs";
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const image = await openai.images.edit({
    image: fs.createReadStream("otter.png"),
    mask: fs.createReadStream("mask.png"),
    prompt: "A cute baby sea otter wearing a beret",
  });

  console.log(image.data);
}
main();

响应

1
2
3
4
5
6
7
8
9
10
11
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

创建图像变体

POST https://api.openai.com/v1/images/variations

创建给定图像的变体。source

请求正文

图像

文件source

必填

用作变体基础的图像。必须是有效的 PNG 文件，大小小于 4MB，并且是正方形。source

MODEL

字符串source

可选

默认为 dall-e-2

用于图像生成的模型。只dall-e-2目前支持。source

整数或 nullsource

可选

默认为 1

要生成的图像数。必须介于 1 和 10 之间。为dall-e-3只n=1受支持。source

response_format

string 或 nullsource

可选

默认为 url

返回生成图像的格式。必须是以下之一url或b64_json.URL 仅在图像生成后的 60 分钟内有效。source

大小

string 或 nullsource

可选

默认为 1024x1024

生成的图像的大小。必须是以下之一256x256,512x512或1024x1024.source

用户

字符串source

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多。source

返回图像对象列表。source

示例请求

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

1
2
3
4
5
6
7
8
from openai import OpenAI
client = OpenAI()

response = client.images.create_variation(
  image=open("image_edit_original.png", "rb"),
  n=2,
  size="1024x1024"
)

1
2
3
4
5
6
7
8
9
10
11
12
13
import fs from "fs";
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const image = await openai.images.createVariation({
    image: fs.createReadStream("otter.png"),
  });

  console.log(image.data);
}
main();

响应

1
2
3
4
5
6
7
8
9
10
11
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

图像对象

表示 OpenAI API 生成的图像的 url 或内容。source

b64_json

字符串source

生成图像的 base64 编码的 JSON，如果response_format是b64_json.source

网址

字符串source

生成图像的 URL，如果response_format是url（默认）。source

revised_prompt

字符串source

用于生成图像的提示（如果提示有任何修订）。source

OBJECT 图像对象

1
2
3
4
{
  "url": "...",
  "revised_prompt": "..."
}