Render template canvas snapshot

POST 
/openapi/2026-01/themes/page-builder/summary

Pass a template id or full canvas data, and get back a text snapshot of the canvas; each node carries a #path number that can be used to target it in edit operations.

Request

application/json

Body

Bodyrequired

schemaobject

Full canvas data (page-builder ProjectData); either schema or id (prefer id)

detail_levelstring

Detail level: minimal, tiered, verbose. Defaults to minimal

detailed_node_idsstring[]

Node paths to expand details for, e.g. 0.1.2

idstring

Template id to summarize; the server loads its canvas data. Either id or schema — prefer id so the full canvas data stays out of the request

typestring

Template type when fetching by id: custom (default, custom card templates), global (public templates). Only honored with id; any other value is rejected. Same values as origin when saving a page-builder block

Example

json

{
  "schema": {},
  "detail_level": "string",
  "detailed_node_ids": [
    "string"
  ],
  "id": "string",
  "type": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

textstring

Canvas text snapshot

timingsobject

Timing metrics

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "text": "string",
    "timings": {}
  }
}