AI Services/Image Generation

Edit Image

Interface description: Edit images synchronously, edit based on reference images and instructions.

Before calling this interface, please request the “Image Editing Models” interface (GET /api/ai/models/image/edit) to obtain the currently available model list and the size, maximum number of input images, and price supported by each model, and then fill in the parameters of this interface accordingly.

Image editing as image-to-image: You must pass in the reference image image, and follow the prompts to modify, redraw or stylize it based on it. If you want to generate a new image (text-to-image) using only text, please use the “Generate Image” interface.

If you are already using the OpenAI SDK or ecological tools, you can use the OpenAI compatible endpoint “OpenAI Image Editing” instead.

POST

api

image

edit

Edit Image

curl --request POST \
  --url https://aitoearn.cn/api/ai/image/edit \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "model": "gpt-image-2",
  "image": "https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80",
  "prompt": "Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style."
}
'

import requests

url = "https://aitoearn.cn/api/ai/image/edit"

payload = {
    "model": "gpt-image-2",
    "image": "https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80",
    "prompt": "Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style."
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'gpt-image-2',
    image: 'https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80',
    prompt: 'Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style.'
  })
};

fetch('https://aitoearn.cn/api/ai/image/edit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://aitoearn.cn/api/ai/image/edit"

	payload := strings.NewReader("{\n  \"model\": \"gpt-image-2\",\n  \"image\": \"https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80\",\n  \"prompt\": \"Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "created": 1,
    "list": [
      {
        "url": "string",
        "b64_json": "string",
        "revised_prompt": "string"
      }
    ],
    "usage": {
      "input_tokens": 1,
      "output_tokens": 1,
      "total_tokens": 1
    },
    "background": "string",
    "output_format": "string",
    "quality": "string",
    "size": "string"
  }
}

Authorizations

X-Api-Key

string

header

required

Need to get API Key from AiToEarn. Click to go to "API Key Obtaining Tutorial".

Body

application/json

model

string

required

Image editing model name. First call the "Image Editing Models" interface (GET /api/ai/models/image/edit) and pass in the data[n].name returned by it; the size, maximum number of input images and price supported by each model shall be subject to the return of this interface.

Example:

"gpt-image-2"

image

required

Source image. Supports one image URL, a data URL, or an array of image URLs. gpt-image-2 currently supports up to 14 input images.

Example:

"https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80"

prompt

string

required

Edit description

Required string length: 1 - 4000

Example:

"Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style."

mask

string

Mask image URL for partial redraw (optional). It needs to be a PNG image with the same size as image: the completely transparent area (alpha is 0) represents the part that needs to be redrawn according to the prompt word, and the opaque area remains unchanged. Edit the entire image when not uploading.

integer

Number of images generated

Required range: 1 <= x <= 1

Example:

1

size

string

Image size. Available values vary by model; use data[n].sizes from Image Editing Models. Pricing varies by size in data[n].pricing. The example uses 1024x1024, which has the lowest price of 1 credit.

Example:

"1024x1024"

response_format

enum<string>

Return format

Available options:

url,

b64_json

Example:

"url"

Response

200 - application/json

The request has been processed by the service. Business success is determined by whether the response body has code === 0.

code

integer

required

Business status code. 0 means success; non-zero means a business error.

message

string

required

Response message.

data

object

Hide child attributes

data.created

number

required

Create timestamp

data.list

object[]

required

Generated image list

Hide child attributes

data.list.url

string

Image URL

data.list.b64_json

string

base64 encoded image

data.list.revised_prompt

string

Revised prompt words

data.usage

object

token usage

Hide child attributes

data.usage.input_tokens

number

Enter the number of tokens

data.usage.output_tokens

number

Output the number of tokens

data.usage.total_tokens

number

Total number of tokens

data.background

string

background

data.output_format

string

Output format

data.quality

string

Quality level

data.size

string

Image size

requestId

string

Request ID.

timestamp

integer

Error response timestamp in Unix milliseconds.

Last modified on September 29, 2026

Edit Image

curl --request POST \
  --url https://aitoearn.cn/api/ai/image/edit \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "model": "gpt-image-2",
  "image": "https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80",
  "prompt": "Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style."
}
'

import requests

url = "https://aitoearn.cn/api/ai/image/edit"

payload = {
    "model": "gpt-image-2",
    "image": "https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80",
    "prompt": "Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style."
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'gpt-image-2',
    image: 'https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80',
    prompt: 'Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style.'
  })
};

fetch('https://aitoearn.cn/api/ai/image/edit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://aitoearn.cn/api/ai/image/edit"

	payload := strings.NewReader("{\n  \"model\": \"gpt-image-2\",\n  \"image\": \"https://images.unsplash.com/photo-1592194996308-7b43878e84a6?auto=format&fit=crop&w=1024&q=80\",\n  \"prompt\": \"Edit the provided image into a cozy realistic scene by placing the cute orange cat beside a sunlit window. Preserve its orange fur, seated pose, and facial expression, enhance the soft natural light, add warm tones and subtle detail, and maintain a realistic photography style.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "created": 1,
    "list": [
      {
        "url": "string",
        "b64_json": "string",
        "revised_prompt": "string"
      }
    ],
    "usage": {
      "input_tokens": 1,
      "output_tokens": 1,
      "total_tokens": 1
    },
    "background": "string",
    "output_format": "string",
    "quality": "string",
    "size": "string"
  }
}