Outpaint

The Outpaint service inserts additional content in an image to fill in the space in any direction. Compared to other automated or manual attempts to expand the content in an image, the Outpaint service should minimize artifacts and signs that the original image has been edited.

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/outpaint	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	The image you wish to outpaint.Supported Formats:jpeg、png、webp
left、right、up、	integer	No	The number of pixels to outpaint on the left side of the image. At least one outpainting direction must be supplied with a non-zero value.
creativity	number	No	[ 0 .. 1 ] Default: 0.5. Controls the likelihood of creating additional details not heavily conditioned by the init image.
prompt	string	No	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.
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/outpaint",
    headers={
        "authorization": f"your-auth-token"
    },
    files={
        "image": open("./your-image.png", "rb")
    },
    data={
        "left": 200,
        "down": 200,
        "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"
}