Skip to main content
[Important: API Service Retirement Announcement]Dear Developers,Thank you for your continued trust and support in AILabTools API. In order to provide more efficient and reliable services, we will officially deprecate the current version of this API.As this interface is based on an outdated architecture and its performance can no longer meet evolving needs, it will no longer be available starting from the date of this announcement.We kindly recommend that you evaluate and adopt an alternative solution as soon as possible to ensure a smooth transition for your applications.If you have any questions or need assistance during the migration, please feel free to contact our support team: ๐Ÿ“ง [email protected]We sincerely appreciate your understanding and cooperation, and we remain committed to delivering better and more advanced services for you.Warm regards,AILabTools Support Team

โ€‹
Request

  • URL: https://www.ailabapi.com/api/cutout/general/apparel-background-removal
  • Method: POST
  • Content-Type: multipart/form-data

โ€‹
Image requirements

  • Image format: JPEG JPG BMP PNG
  • Image size: No more than 5 MB.
  • Image resolution: Larger than 50x50px, smaller than 3000x3000px.

โ€‹
Headers

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

โ€‹
Body

FieldRequiredTypeScopeExampleDescription
imageYESfile
cloth_classNOstringtops, coat, skirt, pants, bag, shoes, hattops,coattops`: Tops.`, coat: Coat., skirt`: Skirt.`, pants: Pants., bag`: Bag.`, shoes: Shoes., โ€œhat: Hat.
return_formNOstringmask, whiteBKwhiteBK`: Returns an image with a white background.`, mask: Returns a single-channel mask., If not specified, a four-channel PNG image will be returned.

โ€‹
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

FieldTypeDescription
dataobjectThe content of the result data returned.
+elementsarrayReturns an array of elements.
++0object
+++image_urlstringReturns the keying result image URL address.
++1object
+++class_urlobjectReturn the URL corresponding to the clothing category based on the input cloth_class.
++++topsstringTops URL.
++++coatstringCoat URL.
++++skirtstringSkirt URL.
++++pantsstringPants URL.
++++bagstringBag URL.
++++shoesstringShoes URL.
++++hatstringHat URL.
The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.

โ€‹
Response Example

,
  "data":         ,
      
      }
    ]
  }
}

โ€‹
Sample Code

[๐Ÿ‘‰ Online Experience ๐Ÿ‘ˆ(https://www.ailabtools.com/cutout-clothing-background-removal-example)] If youโ€™d like to see the actual effects, please visit the experience page for a trial.