Skip to main content
POST
/
ai
/
openai
/
v1
/
images
/
edits
openai compat edits
curl --request POST \
  --url https://ai.pmock.com/api/ai/openai/v1/images/edits \
  --header 'Content-Type: multipart/form-data' \
  --form 'image=<string>' \
  --form 'prompt=<string>' \
  --form model=gpt-image-2 \
  --form background=transparent \
  --form inputFidelity=high \
  --form mark='@example-file' \
  --form moderation=auto \
  --form n=123 \
  --form outputCompression=123 \
  --form outputFormat=png \
  --form responseFormat=b64_json \
  --form partialImages=123 \
  --form quality=auto \
  --form size=auto \
  --form 'user=<string>' \
  --form image.items='@example-file'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.pmock.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Maven

<dependency>
    <groupId>com.openai</groupId>
    <artifactId>openai-java</artifactId>
    <version>x.x.x</version>
</dependency>

​
Normal Request Example

@Test
void imageEditTest() {
    OpenAIClient client = OpenAIOkHttpClient.builder()
            .apiKey(apiKey) // Your apiKey
            .baseUrl("https://ai.pmock.com/api/ai/openai/v1")
            .build();

    ImageEditParams params = ImageEditParams.builder()
            .image(Path.of("D:\\20260226142856_235_166.png")) // Your image
            .prompt("change the color to green")
            .responseFormat(ImageEditParams.ResponseFormat.B64_JSON)
            .build();
    ImagesResponse imagesResponse = client.images().edit(params);
    System.out.println(imagesResponse.data());
}

Body

multipart/form-data
​
image
file[]
required

images

Minimum array length: 1
​
prompt
string
required

prompt

Minimum string length: 1
​
model
enum<string>
default:gpt-image-2
required

model

Available options:
gpt-image-2
​
background
enum<string>

background transparency

Available options:
transparent,
opaque,
auto
​
inputFidelity
enum<string>

Input image fidelity (newly added in gpt-image-2, only effective for editing scenes); Generate can be ignored)

Available options:
high,
low
​
mark
file

mark

​
moderation
enum<string>

Audit intensity

Available options:
auto,
low
​
n
integer<int32>

n

​
outputCompression
integer<int32>

JPEG/WebP compression level 0-100

​
outputFormat
enum<string>

Output file format

Available options:
png,
jpeg,
webp
​
responseFormat
enum<string>
default:b64_json

Response format (compatible with DALL · E; The gpt image series always returns b64_json)

Available options:
url,
b64_json
​
partialImages
integer<int64>

partialImages

​
quality
enum<string>

quality

Available options:
auto,
low,
medium,
high,
standard
​
size
enum<string>

size

Available options:
auto,
1024x1024,
1024x1536,
1536x1024,
2048x2048,
2048x1152,
3840x2160,
2160x3840
​
user
string

user

Response

200 - */*

OK

The response is of type object.