OpenAI API Images

2023-03-21 11:42 更新

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

Create image

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

根据提示创建图像。

Request body

字段	类型	是否可选	说明
prompt	string	必须	所需图像的文本描述。最大长度为 1000 个字符。
n	integer	可选默认为 1	要生成的图像数。必须介于 1 和 10 之间。
size	string	可选默认为 1024x1024	生成图像的大小。必须是 256x256 、 512x512 或 1024x1024 之一。
response_format	string	可选默认为 url	生成的图像返回的格式。必须是 url 或 b64_json 之一。
user	string	可选	代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。

示例请求

curl python node.js

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"
  }'

import os
import openai
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Image.create(
  prompt="A cute baby sea otter",
  n=2,
  size="1024x1024"
)

const { Configuration, OpenAIApi } = require("openai");
const configuration = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.createImage({
  prompt: "A cute baby sea otter",
  n: 2,
  size: "1024x1024",
});

参数

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

响应

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

Create image edit

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

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

Request body

字段	类型	是否可选	说明
image	string	必须	要编辑的图像。必须是有效的 PNG 文件，小于 4MB，并且是方形的。如果未提供遮罩，图像必须具有透明度，将用作遮罩。
mask	string	可选	完全透明区域（例如 alpha 为零的区域）的附加图像指示应编辑图像的位置。必须是有效的 PNG 文件，小于 4MB，并且与图像具有相同的尺寸。
prompt	string	必须	所需图像的文本描述。最大长度为 1000 个字符。
n	integer	可选默认为 1	要生成的图像数。必须介于 1 和 10 之间。
size	string	可选默认为 1024x1024	生成图像的大小。必须是 256x256 、 512x512 或 1024x1024 之一。
response_format	string	可选默认为 url	生成的图像返回的格式。必须是 url 或 b64_json 之一。
user	string	可选	代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。

示例请求

curl python node.js

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"

import os
import openai
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Image.create_edit(
  image=open("otter.png", "rb"),
  mask=open("mask.png", "rb"),
  prompt="A cute baby sea otter wearing a beret",
  n=2,
  size="1024x1024"
)

const { Configuration, OpenAIApi } = require("openai");
const configuration = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.createImageEdit(
  fs.createReadStream("otter.png"),
  fs.createReadStream("mask.png"),
  "A cute baby sea otter wearing a beret",
  2,
  "1024x1024"
);

响应

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

Create image variation

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

创建给定图像的变体。

Request body

字段	类型	是否可选	说明
image	string	必须	用作变体基础的图像。必须是有效的 PNG 文件，小于 4MB，并且是方形的。
n	integer	可选默认为 1	要生成的图像数。必须介于 1 和 10 之间。
size	string	可选默认为 1024x1024	生成图像的大小。必须是 256x256 、 512x512 或 1024x1024 之一。
response_format	string	可选默认为 url	生成的图像返回的格式。必须是 url 或 b64_json .user 之一
user	string	可选	代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。

示例请求

curl python node.js

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

import os
import openai
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Image.create_variation(
  image=open("otter.png", "rb"),
  n=2,
  size="1024x1024"
)

const { Configuration, OpenAIApi } = require("openai");
const configuration = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.createImageVariation(
  fs.createReadStream("otter.png"),
  2,
  "1024x1024"
);

响应

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

以上内容是否对您有帮助：

← OpenAI API Edits

OpenAI API Embeddings →

写笔记

我要补充