Skip to content

madoo.image-set/v1

Madoo image set — A list of images, each a Madoo storage reference with an optional label and metadata: frames of a video, pages, any set of pictures.

Reference madoo.image-set/v1
Schema id urn:madoo:schema:image-set:v1
Version 1.0.0
Served at GET /api/v1/json-schemas/madoo.image-set/v1 · MCP get_json_schema
  • Produced by: video/extract_scenes → frames
  • Read by: ai/decide → image_set, ai/image_analysis → image_set
Field Type Required Rules Description
schema "madoo.image-set/v1" yes
images array of objects yes
images[].index integer ≥ 1 Position in the set, from 1.
images[].image object yes
images[].image.kind "image_uri" yes
images[].image.uri string yes min length 1
images[].content_type string
images[].width integer ≥ 1
images[].height integer ≥ 1
images[].label string Text to show with the image; Image Analysis sends it just before the image.
images[].metadata object Free fields of the producer (Extract Scenes: time, scene).
madoo.image-set/v1 (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:madoo:schema:image-set:v1",
"title": "Madoo image set",
"description": "A list of images in a meaningful order, each pointed at the way a keyframe map points at one ({\"kind\": \"image_uri\", \"uri\": …}), with an optional label to show beside it and free metadata of the producer. Written by Extract Scenes (video/extract_scenes, one image per chosen frame, label \"t = 12.4 s\", metadata time and scene); read by the JSON Enumerator (arrayPath images, image.uri as an image) and by any step that takes a set of images. Built from other images with Generate JSON (item_fields {\"image\": {\"kind\": \"image_uri\"}}). A uri is a Madoo storage reference of the workspace that reads it.",
"type": "object",
"required": [
"schema",
"images"
],
"properties": {
"schema": {
"const": "madoo.image-set/v1"
},
"images": {
"type": "array",
"items": {
"type": "object",
"required": [
"image"
],
"properties": {
"index": {
"type": "integer",
"minimum": 1,
"description": "Position in the set, from 1."
},
"image": {
"type": "object",
"required": [
"kind",
"uri"
],
"properties": {
"kind": {
"const": "image_uri"
},
"uri": {
"type": "string",
"minLength": 1
}
}
},
"content_type": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": 1
},
"height": {
"type": "integer",
"minimum": 1
},
"label": {
"type": "string",
"description": "Text to show with the image; Image Analysis sends it just before the image."
},
"metadata": {
"type": "object",
"description": "Free fields of the producer (Extract Scenes: time, scene)."
}
}
}
}
},
"examples": [
{
"schema": "madoo.image-set/v1",
"images": [
{
"index": 1,
"image": {
"kind": "image_uri",
"uri": "org/ws/executions/run/frame_001.jpg"
},
"content_type": "image/jpeg",
"width": 1280,
"height": 720,
"label": "t = 2.6 s",
"metadata": {
"time": 2.633,
"scene": 1
}
},
{
"index": 2,
"image": {
"kind": "image_uri",
"uri": "org/ws/executions/run/frame_002.jpg"
},
"content_type": "image/jpeg",
"width": 1280,
"height": 720,
"label": "t = 11.3 s",
"metadata": {
"time": 11.3,
"scene": 2
}
}
]
}
]
}