Image

Type key: image. Renders an image from a public URL, with an optional caption. In the editor this is the Image block.

A content block: it can sit at the page root, in a layout row column, or in a question’s supporting content.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the image tab.

Example

A minimal Image node

{
  "public_id": "nImg",
  "sort_order": 1,
  "type": "image",
  "meta": {
    "image_url": "https://cdn.example.com/acme-events/venue.jpg",
    "image_caption": "<span>The venue in Amsterdam</span>",
    "image_alignment": "center"
  }
}

Defaults and rules

• image_url must be a public http or https URL of up to 1,000 characters. The document holds only the URL: host the file first.
• The defaults are image_alignment: "center" and image_full_width: true. image_url, image_caption, image_width, and image_height default to null.
• image_width and image_height are positive integers in pixels; null keeps the natural size. image_full_width: true stretches the image to the form width.
• image_caption is inline rich text with at most 2,000 visible characters.