画像を編集

1 枚または複数の入力画像とテキストプロンプトから編集結果を生成します。マスクを使用して編集対象領域を指定することもできます。

POST/v1/images/edits

1 枚または複数の入力画像とテキストプロンプトから編集済み画像を作成します。マスクを指定した場合、マスクの透明領域が編集対象を示します。複数画像を編集する場合、マスクは最初の入力画像に適用されます。

入力ファイルの種類、サイズ、数、マスク規則、品質、サイズのオプションは、選択したモデルによって異なります。現在の API Key から参照でき、画像編集に対応するモデル ID を使用してください。

認証

bearerAuth

認証Bearer <token>

Authorization Header に Bearer your-api-key を指定します。

指定位置: header

リクエストボディ

multipart/form-data

Multipart を使用して画像、プロンプト、任意のマスクを送信します。Content-Type の boundary はリクエストライブラリに自動生成させてください。

TypeScript 型定義

TypeScript で request body 型を使用します。

image*|array<>

編集する 1 枚または複数の画像です。DALL·E 2 は 4 MB 未満の正方形 PNG を受け付けます。mask を指定しない場合、画像に透明領域が必要です。GPT-Image-1 は複数の PNG、WEBP、JPG を受け付け、各ファイルは 25 MB 未満である必要があります。

実際に対応するファイル形式、サイズ、数は選択したモデルに従います。

prompt*string

希望する編集結果です。DALL·E 2 は最大 1,000 文字、GPT-Image-1 は最大 32,000 文字を受け付けます。その他のモデルの制限は実際の機能に従います。

長さ1 <= length

mask?file

任意のマスク画像です。完全に透明な領域が編集対象を示します。マスクは 4 MB 未満の PNG で、入力画像と同じサイズにしてください。複数画像を編集する場合、マスクは最初の画像に適用されます。

形式binary

model*string

使用する画像編集モデル ID です。現在の API Key から参照でき、画像編集に対応するモデルを選択してください。

長さ1 <= length

n?integer|null

返す画像数です。1～10 を指定でき、実際に対応する数は選択したモデルによって異なります。

範囲1 <= value <= 10

デフォルト値1

quality?string|null

画像品質です。GPT-Image-1 は high、medium、low、DALL·E 2 は standard に対応し、デフォルト値は auto です。

デフォルト値"auto"

指定可能な値

"auto"
"high"
"medium"
"low"
"standard"
null

response_format?string|null

画像のレスポンス形式です。url は生成後 60 分間有効な画像 URL を返し、b64_json は Base64 エンコード済み画像データを返します。

デフォルト値"url"

指定可能な値

"url"
"b64_json"
null

size?string|null

画像サイズです。GPT-Image-1 は 1024x1024、1536x1024、1024x1536、auto、DALL·E 2 は 256x256、512x512、1024x1024 に対応します。

デフォルト値"1024x1024"

指定可能な値

"256x256"
"512x512"
"1024x1024"
"1536x1024"
"1024x1536"
"auto"
null

user?string

エンドユーザーを表す一意の識別子です。監視や不正利用の検出に使用できます。

長さ1 <= length

レスポンスボディ

`application/json`

curl -X POST "https://example.com/v1/images/edits" \  -F model="MODEL_ID" \  -F image="otter.png" \  -F mask="mask.png" \  -F prompt="ベレー帽をかぶったかわいいラッコ" \  -F n="1" \  -F size="1024x1024"

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://example.com/edited-image-1.png"
    },
    {
      "url": "https://example.com/edited-image-2.png"
    }
  ]
}

認証

リクエストボディ

レスポンスボディ

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`