Skip to main content

AILabTools API - Head Extraction - 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/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.
  • Uploading images with multiple faces may cause service timeouts or errors. It is recommended to keep the number of faces per image under five.

Headers​

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get 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​

    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.
    +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.

    Response Example​

    {
      "request_id":     "",
      "log_id":         "",
      "error_code":     0,
      "error_msg":      "",
      "error_detail":   {
        "status_code":  200,
        "code":         "",
        "code_message": "",
        "message":      ""
      },
      "data":           {
        "elements": [
          {
            "image_url": "",
            "width":     0,
            "height":    0,
            "x":         0,
            "y":         0
          }
        ]
      }
    }

    Sample Code​

    👉 Online Experience 👈

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

    Last updated on