Rivier/ Reference/ hosting

What a visual editor needs for a page

get/hosting/sites/{id}/pages/{page}/canvas

What a visual editor needs for a page: every block with its place, author, locks, editable props (type, limits, options), slots (what they take, how many) and text values, plus the blocks that can be added. Pair it with the preview rendered with ?annotate=1, whose elements carry the same ids.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:read
Mcp
rivier_site_canvas_get
Graphql
Query.hostingSitePageCanvas
Sdk
hosting.sitePage.canvas
Cli
hosting site page canvas

Parameters

  • idstring (uuid)required
    In the path
  • pagestring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown