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.
Field Required Type Description
ailabapi-api-key YES string Application API KEY.

Body

Field Required Type Scope Description
image YES file
return_form NO string
  • 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

    Field Type Description
    error_code integer Status Code.
    error_code_str string Error Code.
    error_msg string Error Message.
    request_id string Request ID.
    log_id string Log ID.
    data object The content of the result data returned.
    +elements array The keying result of each child element.
    ++image_url string Resulting image URL address.
    ++width integer The width of the result map.
    ++height integer The height of the resultant graph.
    ++x integer Top left x-coordinate.
    ++y integer Top left y-coordinate.

    [!NOTE|style:flat] 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

    Copyright © 2023 AILabTools all right reservedFile Modify: 2023-06-13

    results matching ""

      No results matching ""