Skip to main content
Version: 1.1.0

Structure of API-request

Swagger web interface contains the following types of requests: Process Sample and Process Image.

img.png

Process Sample​

Content-Type: application/json

Path: <image_api_url>/<service_name>/process/sample

The request body is a sample that contains:

  • $image - input image in base64
  • objects - processing objects (faces and bodies)

Each object has a certain set of attributes, which differs depending on the service used. In response, API returns these attributes with calculated values.

Note: fields marked with a “$”, for example $image, indicate that the value is encoded in base64 format.

Process Image​

Content-Type: multipart/form-data

Path: <image_api_url>/<service_name>/process/image

The request body is an image in jpg, png or bmp.

Note: this interface is not available for quality-assessment-estimator, verify-matcher, age-estimator, mask-estimator, emotion-estimator, gender-estimator, as they require additional object attributes as input data. You can check the availability of a certain service interface in the Swagger web interface.