Sign in

v1

latestOpenAPI 3.0.32026-07-26214565.6 KB
Face Detection (Legacy)

Face Detect (Legacy)

Note: This endpoint will be deprecated in a future release. We recommend using the new Detect Faces API for all new integrations.

The new endpoint provides:

  • Support for both images and videos
  • Base64 image input support
  • Cropped face image URLs
  • Single face mode
  • Better face tracking for videos

Legacy endpoint to detect faces in images and get landmark information.

post/detect

Request body

single_faceboolean required

Set to true to return only the largest face data, or false to return all detected faces.

image_urlstring

Image link. You can choose to enter this parameter or the img parameter.

imgstring

Image base64 information. You can choose to enter this parameter or the image_url parameter.

Response

Face detection completed

error_codeinteger

Interface returns business status code (0: success)

error_msgstring

Error message of this API

landmarks_strstring[]

Landmark string representation

secondsnumber

API time-consuming

trx_idstring

Transaction ID