Edits（Modify Image）

1. Function Introduction

Upload the original image and the mask image (optional), combine them with text prompts, and let the AI model replace the content of the specified area in the image to generate an edited image.
Supports GPT-Image series and DALL-E 2 model, suitable for scenarios such as image restoration, content replacement, and style adjustment.

Precise regional editing: Specify the editing area through a mask image to achieve local content replacement

Multi-model adaptation: Supports GPT-Image series (efficient and flexible) and DALL-E 2 (classic and stable)

Rich parameter control: Customizable image size, quality, output format, compression level, etc.

Batch generation: Supports generating 1-10 edited images at once to meet diverse needs

Transparent background support: The GPT-Image model can generate images with transparent backgrounds, suitable for design scenarios

2. Request Parameters

Field	Type	Required	Description	Remarks
Image	File	✅	Original image file	≤ 50 MB; Supports PNG/JPEG/WebP
mask	file		Mask Image	Must be the same size as the original image and contain an alpha channel
prompt	string	✅	Edit prompt	Length ≤ 32 k (gpt-image-1.5)
model	string	✅	Model	gpt-image-1.5 / gpt-image-1 / gpt-image-1-mini
n	int		Number of output sheets	1-10
size	string		Output size	Same as the generation interface, see the size table
quality	string		Quality	low / medium / high / auto
background	string		Background	transparent / opaque / auto
input_fidelity	string		Input Fidelity	low / high; high better preserves face/Logo
output_format	string		Output format	png / jpeg / webp
output_compression	int		Compression ratio	0-100; only for jpeg/webp
moderation	string		moderation strictness	low / auto
stream	bool		Streaming	Only for GPT-Image series
partial_images	int		Streaming sharding	0-3
async	query		Whether asynchronous	?async=true returns task_id

3. Precautions

✅ The original image and mask image must meet the format and size restrictions of the corresponding model (see parameter description for details)

🎭 The mask image must have the same dimensions as the original image, with the transparent area (alpha=0) being the editing area

🔒 Editing sensitive content is not supported, and the system will conduct content moderation

⚠️ APIFOX does not support online debugging of this API and requires testing via code calls

🚫 Uploading infringing or illegal images is prohibited

4. Price

Model	Text Input	Image Input	Image Output
gpt-image-1	5 PTC/1M Tokens	10 PTC/1M Tokens	40 PTC/1M Tokens
gpt-image-1-mini	2 PTC/1M Tokens	2.5 PTC/1M Tokens	8 PTC/1M Tokens
gpt-image-1.5	5 PTC/1M Tokens	8 PTC/1M Tokens	32 PTC/1M Tokens

The final price shall be based on the number of Tokens consumed as returned by the request
gpt-image-1: Price Reference

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "background": "opaque",
    "created": 1765963391,
    "data": [
        {
            "url": "https://file.302.ai/gpt/imgs/20251217/3de34788dedd4b84834bb428ae742615.png"
        }
    ],
    "output_format": "png",
    "quality": "high",
    "size": "1024x1024",
    "usage": {
        "input_tokens": 10977,
        "input_tokens_details": {
            "image_tokens": 10917,
            "text_tokens": 60
        },
        "output_tokens": 4160,
        "total_tokens": 15137
    }
}

1. Function Introduction#

2. Request Parameters#

3. Precautions#