mask gpt-image-1

POST

/v1/images/edits

Given a hint, the model will return the completion of one or more predictions, and can also return the probability of the alternative label at each location.

Completed creation based on the provided prompts and parameters

Official documentation: https://platform.openai.com/docs/api-reference/images/createEdit

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/images/edits' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--form 'image=@"C:\\Users\\Administrator\\Desktop\\sunlit_lounge.png"' \
--form 'prompt="A sunlit indoor lounge area with a pool containing a flamingo"' \
--form 'mask=@"C:\\Users\\Administrator\\Desktop\\mask.png"' \
--form 'model="gpt-image-1"' \
--form 'n="1"' \
--form 'quality=""' \
--form 'response_format="b64_json"' \
--form 'size="1024x1024"' \
--form 'background="transparent"' \
--form 'moderation="low"'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "\n\nHello there, how may I assist you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}

Modified at 2026-09-23 08:28:57

Edit gpt-image-1

Create gpt-image-1.5