VisionImageRequest vision.image-request@1

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

Version
1.0.0
Owner
vision
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vision/image-request.v1.json

vision.image-request@1: one image for OpenVibe.Vision's one-shot tools, as a data URL or a public URL. The multipart form field `image` carries the same bytes. Private tools (find, index, watch, moments) accept only uploaded bytes or a data URL, never an unverified source URL.

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

Examples

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

Valid: one
{
  "image": "data:image/png;base64,iVBORw0KGgo="
}
Rejected: one
{
  "image": "https://example.com/a.png"
}

Validate

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