Skip to main content
POST
/
v1
/
images
/
edits
Edit an image (OpenAI)
curl --request POST \
  --url https://api.ai.cc/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'model=<string>' \
  --form 'prompt=<string>' \
  --form image='@example-file' \
  --form 'background=<string>' \
  --form 'input_fidelity=<string>' \
  --form n=123 \
  --form 'output_format=<string>' \
  --form partial_images=123 \
  --form 'quality=<string>' \
  --form 'response_format=<string>' \
  --form 'size=<string>'
{
  "created": 123,
  "data": [
    {
      "url": "<string>",
      "b64_json": "<string>",
      "revised_prompt": "<string>"
    }
  ]
}
This endpoint integrates a third-party model. For detailed parameter information, please refer to the official documentation at OpenAI Docs.

Authorizations

​
Authorization
string
header
required

Authentication is done using Bearer Token. Format: Authorization: Bearer sk-xxxxxx

Body

multipart/form-data
​
model
string
required
​
prompt
string
required
​
image
file
required

The image(s) to edit. Must be a supported image file or an array of images.

For the GPT image models (gpt-image-1, gpt-image-1-mini, and gpt-image-1.5), each image should be a png, webp, or jpg file less than 50MB

​
background
string

Allows to set transparency for the background of the generated image(s). This parameter is only supported for the GPT image models. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image.

​
input_fidelity
string

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

​
n
integer

The number of images to generate. Must be between 1 and 10

​
output_format
string

The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp.

​
partial_images
integer

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

​
quality
string

The quality of the image that will be generated. auto (default value) will automatically select the best quality for the given model. high, medium and low are supported for the GPT image models. hd and standard are supported for dall-e-3. standard is the only option for dall-e-2.

​
response_format
string

The format in which generated images with dall-e-2 and dall-e-3 are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.

​
size
string

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for the GPT image models, one of 256x256, 512x512, or 1024x1024 for dall-e-2, and one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3.

Response

200 - application/json

Image generated successfully

​
created
integer
​
data
object[]