VisionWatchRequest vision.watch-request@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/watch-request.v1.json

vision.watch-request@1: the body of POST /api/v1/watch (owner-granted camera alerts). `classes` names 1–20 things to look for (snow, delivery, package, a DETR label, or "scene change"); `previous_image` is required for a scene change and is compared by histogram.

Fields

FieldTypeRequiredDescriptionConstraints
imagestringThe image as a data URL (base64).
  • pattern ^data:image/
image_urlstringA public image URL, fetched through Vision's private-address guard.
  • pattern ^https?://
  • format uri
classesarray of stringyes
  • minItems 1
  • maxItems 20
  • items: maxLength 60
previous_imagestring
  • pattern ^data:image/

Examples

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

Valid: one
{
  "image": "data:image/png;base64,iVBORw0KGgo=",
  "classes": [
    "package",
    "scene change"
  ],
  "previous_image": "data:image/png;base64,iVBORw0KGgo="
}
Rejected: one
{
  "image": "data:image/png;base64,iVBORw0KGgo=",
  "classes": []
}

Validate

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