Структура API-запроса

В веб-интерфейсе Swagger описаны две версии API (v1 и v2), в каждой из которых реализованы два вида запросов: Process Sample и Process Image.

ВНИМАНИЕ

Начиная с версии 2.0.0, пути /process/sample и /process/image устарели и более не поддерживаются. Настоятельно рекомендуем перейти на новый формат путей.

Process Sample (Обработка сэмпла)

Content-Type: application/json

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

В качестве тела запроса выступают сэмплы, содержащие:

• Для API v1
  • $image — исходное изображение в формате base64.
  • objects — объекты обработки (лица и силуэты).
• Для API v2
  • _image
    • blob — исходное изображение в формате base64.
    • format — формат закодированных данных, например "IMAGE".
  • objects — объекты обработки (лица и силуэты).

Для каждого объекта обработки предусмотрен набор атрибутов, который отличается в зависимости от используемого сервиса. В ответ API возвращает атрибуты с вычисленными значениями.

примечание

Поля, отмеченные знаками "$" и "_", например, $image или _image, определяют, что по данному ключу находятся бинарные данные, закодированные в формате base64.

Process Image (Обработка изображения)

Content-Type: multipart/form-data

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

В качестве тела запроса выступает изображение в одном из форматов: jpg, png, bmp.

примечание

Интерфейс недоступен для сервисов quality-assessment-estimator, verify-matcher, age-estimator, mask-estimator, emotion-estimator, gender-estimator, liveness-estimator, template-extractor, т.к. для их работы требуются дополнительные атрибуты объектов в качестве входных данных. Доступность интерфейса отдельно взятого сервиса можно проверить в веб-интерфейсе Swagger.