Skip to main content

AILabTools API - Head Extraction - API

Request

  • URL: https://www.ailabapi.com/api/cutout/portrait/avatar-extraction
  • Method: POST
  • Content-Type: multipart/form-data

Image requirements

  • Image format: JPEG JPG BMP PNG
  • Image size: No more than 3 MB.
  • Image resolution: Larger than 32x32px, smaller than 2000x2000px.
FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY.

Body

FieldRequiredTypeScopeDescription
imageYESfile
return_formNOstring
  • mask
  • Specifies the form of the returned image.
  • If not set, the four-channel PNG map is returned.
  • mask: Returns a single channel mask.
  • Response

    Parameters

    FieldTypeDescription
    error_codeintegerStatus Code.
    error_code_strstringError Code.
    error_msgstringError Message.
    request_idstringRequest ID.
    log_idstringLog ID.
    dataobjectThe content of the result data returned.
    +elementsarrayThe keying result of each child element.
    ++image_urlstringResulting image URL address.
    ++widthintegerThe width of the result map.
    ++heightintegerThe height of the resultant graph.
    ++xintegerTop left x-coordinate.
    ++yintegerTop left y-coordinate.
    tip

    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.

    Example

    {
    "error_code": 0,
    "error_code_str": "",
    "error_msg": "",
    "request_id": "",
    "log_id": "",
    "data": {
    "elements": [
    {
    "image_url": "",
    "width": 0,
    "height": 0,
    "x": 0,
    "y": 0
    }
    ]
    }
    }

    Code example

    If you'd like to see the actual effects, please visit the experience page for a trial.