Head Extraction API

Request

Image requirements

• Image format: JPEG JPG BMP PNG
• Image size: No more than 3 MB.
• Image resolution: Larger than 32x32px, smaller than 2000x2000px.

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

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

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
      }
    ]
  }
}