> ## Documentation Index
> Fetch the complete documentation index at: https://ailabtools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Remove Objects Advanced API
> Remove Objects Advanced API removes masked objects, people, or text from images with more precise AI inpainting results.
## Request
* **URL**: `https://www.ailabapi.com/api/image/editing/remove-objects-advanced`
* **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](/docs/get-api-key) |
### Body
| Field | Required | Type | Scope | Default | Description |
| :------------ | :------- | :-------- | :------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `image` | YES | `file` | | | Original image. |
| `mask` | YES | `file` | | | Mask image. |
| `steps` | NO | `integer` | \[1, +] | `30` | 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. |
| `strength` | NO | `float` | \[0.1, 1.0] | `0.8` | The smaller the value, the closer it is to the original image. |
| `scale` | NO | `float` | \[1, 20] | `7` | The degree to which the text description influences the output. |
| `seed` | NO | `integer` | \[-1, +] | `0` | 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. |
| `dilate_size` | NO | `integer` | \[1, +] | `15` | Mask Dilation Radius. The mask used for object removal should fully encompass the target object. When users manually draw the mask, it often extends beyond the object's boundary. However, if the mask is generated by a segmentation algorithm, it typically adheres closely to the object's edges, which might leave parts of the object uncovered. This can lead to incomplete removal or unexpected artifacts during generation. To avoid such issues, it's recommended to appropriately increase the `dilate_size` parameter to ensure the mask fully covers the object. |
| `quality` | NO | `string` | `H`, `M`, `L` | `M` | ``H`: High quality — best output quality, but slightly slower processing.`, ``M`: Medium quality — balanced in both quality and speed.`, \`\`L`: Low quality — fastest processing, suitable for scenarios where speed is prioritized.` |
## 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
```json theme={null}
{
"request_id": "",
"log_id": "",
"error_code": 0,
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"binary_data_base64": []
}
}
```
## OpenAPI
````yaml POST /api/image/editing/remove-objects-advanced
openapi: 3.0.0
info:
title: AILabAPI
description: >-
[AILabTools](https://www.ailabtools.com) is an advanced tool that
offers a vast array of simple and flexible API endpoints to suit your
specific needs. With just one [API
KEY](https://www.ailabtools.com/doc/get-api-key), you can easily call
any of the endpoints and integrate them quickly into your application or
workflow, allowing for smooth and efficient operations.
[AILabTools](https://www.ailabtools.com) is continuously evolving,
and you can anticipate even more API endpoints being added in the future,
further enhancing its capabilities and usefulness for your artificial
intelligence and machine learning requirements.
version: 1.0.0
servers:
- url: https://www.ailabapi.com
description: Production server
security:
- apiKeyAuth: []
tags:
- name: AI IMAGE
- name: AI IMAGE > Image Enhancement
- name: AI IMAGE > Image Effects
- name: AI IMAGE > Image Editing
- name: AI IMAGE > Image Scoring
- name: AI BACKGROUND REMOVAL
- name: AI BACKGROUND REMOVAL > Portrait
- name: AI BACKGROUND REMOVAL > General
- name: AI PORTRAIT
- name: AI PORTRAIT > Portrait Effects
- name: AI PORTRAIT > Portrait Enhance
- name: AI PORTRAIT > Portrait Editing
- name: AI PORTRAIT > Portrait Analysis
- name: AI COMMON
paths:
/api/image/editing/remove-objects-advanced:
post:
tags:
- AI IMAGE > Image Editing
summary: Remove Objects Advanced
description: >-
Remove Objects Advanced API removes masked objects, people, or text from
images with more precise AI inpainting results.
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
image:
type: string
description: Original image.
format: binary
mask:
type: string
description: Mask image.
format: binary
steps:
type: integer
description: >-
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.
example: '30'
strength:
type: number
description: >-
The smaller the value, the closer it is to the original
image.
example: '0.8'
scale:
type: integer
description: >-
The degree to which the text description influences the
output.
example: '7'
seed:
type: integer
description: >-
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.
example: '0'
dilate_size:
type: integer
description: >-
Mask Dilation Radius. The mask used for object removal
should fully encompass the target object. When users
manually draw the mask, it often extends beyond the object's
boundary. However, if the mask is generated by a
segmentation algorithm, it typically adheres closely to the
object's edges, which might leave parts of the object
uncovered. This can lead to incomplete removal or unexpected
artifacts during generation. To avoid such issues, it's
recommended to appropriately increase the `dilate_size`
parameter to ensure the mask fully covers the object.
example: '15'
quality:
type: string
description: >-
Quality Parameter. `H`: High quality — best output
quality, but slightly slower processing. `M`:
Medium quality — balanced in both quality and speed.
`L`: Low quality — fastest processing, suitable for
scenarios where speed is prioritized.
example: M
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
request_id: ''
log_id: ''
error_code: 0
error_code_str: ''
error_msg: ''
error_detail:
status_code: 200
code: ''
code_message: ''
message: ''
data:
binary_data_base64: []
description: Success
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: ailabapi-api-key
description: API Key for authentication
````