Search and Replace

The Search and Replace service is a specific version of inpainting ,users can leverage a search_prompt to identify an object in simple language to be replaced. The service will automatically segment the object and replace it with the object requested in the prompt.

Credits

The service uses 8 credits per successful result. You will not be charged for failed results.

Example Request and Response

API Documentation

API Endpoint	Method
/api/edit/search-and-replace	POST

Request Header

Parameter	Description
Authentication	Use your API key to authentication requests to this App.

Request Body

The request should include a JSON object in the body with the following parameters:

Parameter	Type	Required	Description
image	string <binary>	Yes	An image containing content you wish to replace.Supported Formats:jpeg、png、webp
prompt	string	Yes	What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results.
search_prompt	string	Yes	Short description of what to inpaint in the image.
negative_prompt	string	No	apiIntroduction.searchKeyNegatievPrompt
seed	number	No	[ 0 .. 4294967294 ], A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
output_format	string	No	Enum: jpeg png webp

Response Body

The response should include a JSON object in the body with the following parameters:

Parameter	Type	Description
code	int	Status Code, 0 for success callback, -1 for failure callback
message	string	Callback message, 'success' for success, failure reason for failure
data	object	Image Details

Image Details

Parameter	Type	Description
image	string	Return the base64 encoded image of the generated picture.
seed	int	The seed used as random noise for this generation.

Example Request

import requests

response = requests.post(
    f"https://www.aithriving.com/api/edit/search-and-replace",
    headers={
        "authorization": f"your-auth-token"
    },
    files={
        "image": open("./your-image.png", "rb")
    },
    data={
        "prompt": "content",
        "search_prompt": "content",
        "output_format": "webp",
    },
)

if response.status_code == 200:
    data = response.json()
    if data['code'] == 0:
        // image: data['data']['image']
    else:
        // error
else:
    raise Exception(str(response.json()))

Example Response

{
  "code": 0,
  "message": "success",
  "data": "base64 encoded image data"
}