Edit Image by gpt-image-1

Request

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params multipart/form-data

model

string

required

Use gpt-image-1

prompt

string

required

The textual instruction that describes what image we want the model to generate

image

file

required

Input images to be used in the edit

mask

file

optional

Editing mode provides a mask parameter that we can use to specify the areas where the image should be edited. The mask must be a PNG image of at most 4 MB and have the same size as the image. Areas with 100% transparency correspond to the areas that GPT Image 1 is allowed to edit.

n

string

optional

The number of images to generate. Must be a number from 1 to 10.

quality

string

optional

The quality of the generated image. It must be one of "high", "medium", or "low", with the default being "high"

size

string

optional

The size of the image in pixels. It must be one of "1024x1024" (square), "1536x1024" (landscape), "1024x1536" (portrait).

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/images/edits' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--form 'model=""' \
--form 'prompt=""' \
--form 'image=@""' \
--form 'mask=@""' \
--form 'n=""' \
--form 'quality=""' \
--form 'size=""'

Responses

🟢200Create image

application/json

Body

created

integer

required

data

array [object {2}]

required

b64_json

string

optional

url

string

required

usage

object

required

input_tokens

integer

required

input_tokens_details

object

required

output_tokens

integer

required

total_tokens

integer

required

Example

{
    "created": 1748231162,
    "data": [
        {
            "b64_json": "xxxxx"
        }
    ],
    "usage": {
        "input_tokens": 95,
        "input_tokens_details": {
            "image_tokens": 0,
            "text_tokens": 95
        },
        "output_tokens": 4160,
        "total_tokens": 4255
    }
}