VisionFaceBlur vision.face-blur@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
vision
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vision/face-blur.v1.json

vision.face-blur@1: POST /api/v1/faces/blur answers a redacted PNG derivative and the number of faces blurred in X-Faces-Blur. Identity-free, no template, and the original is never stored.

Fields

FieldTypeRequiredDescriptionConstraints
media_typeconstyes
  • = "image/png"
face_countintegeryes
  • minimum 0

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: one
{
  "media_type": "image/png",
  "face_count": 2
}
Rejected: one
{
  "media_type": "image/jpeg",
  "face_count": 2
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('vision.face-blur@1', value);   // { valid, errors: [{ path, message }] }