1. Skin API
EvelabInsight
  • Signature Generation
  • EveLab Insight - Skin Analysis API for All Ethnicities
    • Facial attribute analysis
      POST
    • Facial pose analysis
      POST
    • Skin analysis
      POST
  • EveLab Insight - Basic Data API
    • Basic Data API (Universal Edition) v1.6
  • EveLab Insight - Report API
    • Push Data API
      POST
    • Pull Data API
      GET
  • EveLab Insight - CRM API
    • Search customers
      GET
  • Skin API
    • Get Access Token
      GET
    • Get File Upload Policy
      POST
    • Create Analysis Task
      POST
    • Get Analysis Result
      GET
  1. Skin API

Create Analysis Task

Overseas
https://gapi.evelabinsight.com
Overseas
https://gapi.evelabinsight.com
POST
https://gapi.evelabinsight.com
/skin_api/analyze/task
Create an asynchronous analysis task. This endpoint returns only task_id; use GET /skin_api/analyze/result?task_id=... to query the task status and result. Each task can select only one api_code + algorithm_variant combination.

Request Fields#

FieldRequiredDescription
api_codeYesCapability code. See the supported combinations below.
algorithm_variantYesAlgorithm variant. It must form one of the supported combinations below with api_code.
resourcesConditionalStandard image resource object. Every value must be a directly downloadable HTTP/HTTPS URL; required keys and image count depend on the capability combination.
dimension_codesNoSupported only by eve_v. Omit it or pass [] to use all dimensions available to the current order.
output_optionsNoCurrently used only by online_skin + all_race_v2. If omitted or set to {}, mask_format defaults to annotation_image.
metadataNoCaller-provided notes. They do not affect analysis and are not returned in the result. Do not include passwords, tokens, or personal data.

Supported Capability Combinations#

api_codealgorithm_variantImage Requirementsdimension_codesQuota Rule
eve_vstandardFront, left, and right white-light images are required; submit every optional light source as a complete three-view set.SupportedOne quota unit is consumed only when the task succeeds.
eve_vpartitionSame as standard.SupportedOne quota unit is consumed only when the task succeeds.
online_skinstandardfront_image only.Not supportedOne quota unit is consumed only when the task succeeds.
online_skinall_racefront_image only.Not supportedOne quota unit is consumed only when the task succeeds.
online_skinall_race_v2Either front_image only, or a complete front/left/right set.Not supportedOne quota unit is consumed only when the task succeeds.
face_pose_correctionstandardfront_image only.Not supportedRequires a valid Skin API order; no quota is consumed.
face_pose_correctionall_racefront_image only.Not supportedRequires a valid Skin API order; no quota is consumed.
face_pose_correctionall_race_v2Either front_image only, or a complete front/left/right set.Not supportedRequires a valid Skin API order; no quota is consumed.
facial_analysisstandardfront_image only.Not supportedRequires a valid Skin API order; no quota is consumed.
facial_analysisall_racefront_image only.Not supportedRequires a valid Skin API order; no quota is consumed.

Image Resource Rules#

white_front_image, white_left_image, and white_right_image must all be provided for Eve V.
white_glow, cross_polar, parallel_polar, and uv are optional Eve V light sources. Once a light source is provided, its front, left, and right images must all be provided.
Providing parallel_polar or uv for Eve V also requires a complete cross_polar set.
Single-image capabilities accept only front_image. Three-view capabilities accept either one front image or a complete front/left/right set; two-image combinations are invalid.

output_options#

The currently supported mask_format values are:
annotation_image: returns annotation image URLs grouped by detected dimension. This is the default for online_skin + all_race_v2.
annotation_json: returns annotation JSON file URLs.
Other capability combinations currently do not use output_options; omit it or pass {}.

Compatibility Fields#

New integrations should use the standard fields above. The following fields are retained for compatibility:
pic_url maps to resources.front_image.
json maps to resources and may be a resource object or a JSON object string.
custom maps to metadata.
detect_mask_type=1 maps to output_options.mask_format=annotation_image.
detect_mask_type=2 maps to output_options.mask_format=annotation_json.
detect_face_type=1|2 validates image count consistency only; it does not determine image count.
Image keys matching paralle_polar_* are treated as parallel_polar_*; sensitiveness is treated as sensitivity.
If a standard field and its compatibility field are both present, identical values are accepted; conflicting values are rejected.

Response Handling#

HTTP 200 means only that the request was accepted. Always check meta.code. A value of 0 means the task was created successfully, and response then contains only task_id. On failure, response is {}. Include meta.req_id when requesting support.

Request

Authorization
API Key
Add parameter in header
Access-Token
Example:
Access-Token: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
The HTTP request was processed. Check meta.code; 0 indicates success.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://gapi.evelabinsight.com/skin_api/analyze/task' \
--header 'Access-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "api_code": "eve_v",
    "algorithm_variant": "standard",
    "resources": {
        "white_front_image": "https://example.com/input/white_front.jpg",
        "white_left_image": "https://example.com/input/white_left.jpg",
        "white_right_image": "https://example.com/input/white_right.jpg"
    },
    "output_options": {},
    "metadata": {
        "purpose": "client_request_reference"
    }
}'
Response Response Example
Task Created
The task was accepted. Use task_id to poll its status and result.
{
  "meta": {
    "code": 0,
    "msg": "",
    "error": "",
    "req_id": "4826bbfa2ab1db905e6ac2909682746a",
    "request_uri": "/skin_api/analyze/task"
  },
  "response": {
    "task_id": "1776411212089374452"
  }
}
Previous
Get File Upload Policy
Next
Get Analysis Result
Built with