Media

Type key: media. Embeds a video, song, podcast, or social post from a supported service, with an optional caption. In the editor this is the Media block.

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

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 media tab.

Example

A minimal Media node

{
  "public_id": "nMed",
  "sort_order": 1,
  "type": "media",
  "meta": {
    "media_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "media_caption": "<span>A short tour of the venue</span>",
    "media_alignment": "center",
    "media_full_width": true
  }
}

Defaults and rules

• Send only media_url: a public http or https link of up to 1,000 characters from one of the supported services. The server resolves the link on write, short share links included.
• media_embed is read-only. The server fills it from media_url and ignores any value you send. A node whose media_url is unchanged keeps its stored embed.
• The stored media_url is the tidy link the editor saves, so a read can return a different URL than the one you wrote. Tracking parameters are dropped and share links are expanded.
• A link the server cannot use is a 400 naming /pages/{index}/nodes/{index}/meta/media_url with the media_url_unsupported keyword.
• The defaults are media_alignment: "center" and media_full_width: true. media_width is a positive integer of at most 4,096 pixels and applies only when media_full_width is false.
• media_caption is inline rich text with at most 2,000 visible characters.