vistect.vercel.app

{
  "type": "object",
  "properties": {
    "expectedDocumentVersion": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "The document version this change is written against. Read it from get_document_overview or any read tool. If the document has moved on since then, the write is refused instead of silently overwriting the newer state."
    },
    "pageId": {
      "description": "Defaults to the last page in the document.",
      "type": "string",
      "minLength": 1
    },
    "region": {
      "description": "Which region of the page template to place it in. Defaults to the template's main text region. Call inspect_page to see the regions a page has.",
      "type": "string",
      "enum": [
        "header",
        "flow",
        "figure",
        "sidebar",
        "footer"
      ]
    },
    "textRole": {
      "type": "string",
      "enum": [
        "heading",
        "paragraph",
        "list",
        "quote",
        "callout",
        "statistic",
        "caption",
        "source-note",
        "footnote"
      ],
      "description": "The semantic role. \"heading\" also needs headingLevel. \"list\" takes items instead of content. Roles carry through to the exported HTML, so choose the one that is true rather than the one that looks right."
    },
    "headingLevel": {
      "description": "Required when textRole is \"heading\". Do not skip levels (§10.2).",
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 2
        },
        {
          "type": "number",
          "const": 3
        },
        {
          "type": "number",
          "const": 4
        }
      ]
    },
    "content": {
      "description": "Plain text. Markup is not interpreted.",
      "type": "string",
      "minLength": 1
    },
    "items": {
      "description": "Use with textRole \"list\".",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "ordered": {
      "description": "Numbered rather than bulleted list.",
      "type": "boolean"
    },
    "purpose": {
      "description": "Why this section is on the page. Read back in the object explorer.",
      "type": "string",
      "minLength": 1
    },
    "readingOrderIndex": {
      "description": "Where in the reading order to insert it. Defaults to the end.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "expectedDocumentVersion",
    "textRole"
  ]
}