AILabTools API - AI Object Replacer - API

---

draft: true

Important Announcement: The API Documentation Has Been Fully Updated

This API documentation has been completely restructured with an improved and clearer format. The current page will no longer receive active updates or maintenance. For the most accurate and up-to-date information, please switch to the new documentation.

View New Docs

Request

• URL: https://www.ailabapi.com/api/image/editing/ai-object-replacer
• Method: POST
• Content-Type: multipart/form-data

Image requirements

• Image format: JPEG JPG PNG
• Image size: No more than 5 MB.
• Image resolution: Larger than 64x64px, smaller than 4096x4096px.

Mask image requirements:

1. Single-channel grayscale image (0-255).
2. Three-channel image, with equal RGB values.
3. RGBA four-channel image, with equal RGB values and the A channel all set to 255.
4. File format: 8-bit PNG encoding, do not embed "ICC Profile".

Headers

Field	Required	Type	Description
ailabapi-api-key	YES	string	Application API KEY. Get API KEY

Body

Field	Required	Type	Scope	Default	Description
image	YES	file			Original image.
mask	YES	file			Mask image.
custom_prompt	NO	string			Prompt Content (English only). Please limit the prompt content to 100 English words or fewer. Any content beyond this limit may have minimal impact on the generated result. Use standard vocabulary to avoid failing the review process.
steps	NO	integer	[1, +]	25	Sampling steps determine the level of detail in the generated image. A higher value may result in better quality, but it will significantly increase the processing time.
scale	NO	float	[1, 20]	5	The degree to which the text description influences the output.
seed	NO	integer	[-1, +]	-1	Random seed, used as the basis for determining the initial state of the diffusion process. It must be a non-negative number (-1 represents a random seed). If the random seed is the same positive integer and all other parameters are identical, the generated image will most likely be consistent.

Response

Response Field Handling Flow

1. Handle Public Response Fields

   Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.

2. Handle Business Response Fields

   If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

Public Response Fields

Viewing Public Response Fields and Error Codes

Business Response Fields

Field	Type	Description
data	object	The content of the result data returned.
+binary_data_base64	array of string	Output the processed image as a Base64 array (single image).

Response Example

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "binary_data_base64": []
  }
}

Sample Code

• Introduction to Get Sample Code
• Sample Code