Skip to content

Read body

Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. `getBodySchema` answers the blocks and props each kind of body takes.

Needs the file:read scope.

Call

  • Tool: read_body
  • Scope: file:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
target object Yes
staged boolean No Reads the unpublished next body instead of the live one.
default boolean No Answers the default layout the target’s page shows without a body (the answer’s default set), even while it has one, naming that body as asset; not with staged, and not for a quiz or certificate.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "target": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "product",
            "entry",
            "store",
            "quiz",
            "certificate",
            "page"
          ]
        },
        "id": {
          "description": "Required but for the store's home, which takes the store's own id or none.",
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    },
    "staged": {
      "description": "Reads the unpublished next body instead of the live one.",
      "type": "boolean"
    },
    "default": {
      "description": "Answers the default layout the target's page shows without a body (the answer's `default` set), even while it has one, naming that body as `asset`; not with `staged`, and not for a quiz or certificate.",
      "type": "boolean"
    }
  },
  "required": [
    "target"
  ],
  "additionalProperties": false
}

Answer

The answer is under result.

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo. A read marked transient may be retried.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close