Image Payload
An image source and optional image-local text callouts. Other resource kinds use Asset and do not accept callouts.
Metadata
Field index
This definition uses the forms or value constraints below.
oneOf 1 · string
Exact constraints for oneOf 1
{
"type": "string",
"examples": [
"asset:acme-logo",
"https://cdn.acme.com/image.png",
"./assets/image.png",
"data:image/png;base64,..."
]
}oneOf 2 · object
| Field | Type | Req. | Default | Description |
|---|---|---|---|---|
| src | string | yes | — | Image source. Accepts an 'asset:<id>' reference, HTTPS URL, data URI, relative path resolved against the OPF file location, or local filesystem path. |
| alt | string | — | — | Alternative text for the image. |
| title | string | — | — | Human-readable asset title for editors and asset pickers. |
| description | string | — | — | Optional notes about the asset's contents, provenance, or intended use. |
| mediaType | string | — | — | Optional MIME media type when it cannot be inferred from src. |
| callouts | array<ref:ImageCallout> | — | — | Editable text panels over this image. Coordinates are fractions of its visible frame, measured from the physical top-left even in RTL. Panels are drawn above masks and overlays; overflowing text is reported, never clipped or shrunk below the body role. |
src
typestringrequiredyesdefault—
Image source. Accepts an 'asset:<id>' reference, HTTPS URL, data URI, relative path resolved against the OPF file location, or local filesystem path.
{
"src": "asset:acme-logo"
}alt
typestringrequirednodefault—
Alternative text for the image.
title
typestringrequirednodefault—
Human-readable asset title for editors and asset pickers.
description
typestringrequirednodefault—
Optional notes about the asset's contents, provenance, or intended use.
mediaType
typestringrequirednodefault—
Optional MIME media type when it cannot be inferred from src.
{
"mediaType": "image/svg+xml"
}callouts
typearray<ref:ImageCallout>requirednodefault—
Editable text panels over this image. Coordinates are fractions of its visible frame, measured from the physical top-left even in RTL. Panels are drawn above masks and overlays; overflowing text is reported, never clipped or shrunk below the body role.
Exact constraints for oneOf 2
{
"type": "object",
"additionalProperties": false,
"required": [
"src"
],
"properties": {
"src": {
"type": "string",
"description": "Image source. Accepts an 'asset:<id>' reference, HTTPS URL, data URI, relative path resolved against the OPF file location, or local filesystem path.",
"examples": [
"asset:acme-logo",
"./assets/logo.svg",
"https://cdn.acme.com/logo.png",
"data:image/svg+xml;base64,..."
]
},
"alt": {
"type": "string",
"description": "Alternative text for the image."
},
"title": {
"type": "string",
"description": "Human-readable asset title for editors and asset pickers."
},
"description": {
"type": "string",
"description": "Optional notes about the asset's contents, provenance, or intended use."
},
"mediaType": {
"type": "string",
"description": "Optional MIME media type when it cannot be inferred from src.",
"examples": [
"image/svg+xml",
"image/png",
"image/webp"
]
},
"callouts": {
"type": "array",
"items": {
"$ref": "#/$defs/ImageCallout"
},
"description": "Editable text panels over this image. Coordinates are fractions of its visible frame, measured from the physical top-left even in RTL. Panels are drawn above masks and overlays; overflowing text is reported, never clipped or shrunk below the body role."
}
}
}Complete definition constraints
{
"description": "An image source and optional image-local text callouts. Other resource kinds use Asset and do not accept callouts.",
"oneOf": [
{
"type": "string",
"examples": [
"asset:acme-logo",
"https://cdn.acme.com/image.png",
"./assets/image.png",
"data:image/png;base64,..."
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"src"
],
"properties": {
"src": {
"type": "string",
"description": "Image source. Accepts an 'asset:<id>' reference, HTTPS URL, data URI, relative path resolved against the OPF file location, or local filesystem path.",
"examples": [
"asset:acme-logo",
"./assets/logo.svg",
"https://cdn.acme.com/logo.png",
"data:image/svg+xml;base64,..."
]
},
"alt": {
"type": "string",
"description": "Alternative text for the image."
},
"title": {
"type": "string",
"description": "Human-readable asset title for editors and asset pickers."
},
"description": {
"type": "string",
"description": "Optional notes about the asset's contents, provenance, or intended use."
},
"mediaType": {
"type": "string",
"description": "Optional MIME media type when it cannot be inferred from src.",
"examples": [
"image/svg+xml",
"image/png",
"image/webp"
]
},
"callouts": {
"type": "array",
"items": {
"$ref": "#/$defs/ImageCallout"
},
"description": "Editable text panels over this image. Coordinates are fractions of its visible frame, measured from the physical top-left even in RTL. Panels are drawn above masks and overlays; overflowing text is reported, never clipped or shrunk below the body role."
}
}
}
]
}