RenderSnapshot

Type object

Shape

Field	Type	Description
session_idrequired	TerminalSessionId
terminal_generationrequired	TerminalGeneration
viewport_generationrequired	ViewportGeneration
sequencerequired	StreamSequence	Last event incorporated in this bounded snapshot.
viewportrequired	RowRange
sizerequired	GridSize
rowsrequired	array of TerminalRow
cursorrequired	CursorState
modesrequired	TerminalModes
attentionrequired	AttentionState

Example

{
  "session_id": "00000000-0000-4000-8000-000000000000",
  "terminal_generation": 1,
  "viewport_generation": 1,
  "sequence": {},
  "viewport": {
    "first": 0,
    "count": 0
  },
  "size": {
    "columns": 0,
    "rows": 0
  },
  "rows": [
    {
      "index": 0,
      "cells": [
        {
          "column": 0,
          "text": "string",
          "width": "zero",
          "style": {
            "foreground": {
              "kind": "default_foreground"
            },
            "background": {
              "kind": "default_foreground"
            },
            "bold": false,
            "dim": false,
            "italic": false,
            "underline": false,
            "strikeout": false,
            "inverse": false
          }
        }
      ],
      "wrapped_to_next": false
    }
  ],
  "cursor": {
    "row": 0,
    "column": 0,
    "shape": "block",
    "blinking": false
  },
  "modes": {
    "alternate_screen": false,
    "application_cursor": false,
    "bracketed_paste": false,
    "mouse_reporting": false,
    "mouse_tracking": "off",
    "mouse_encoding": "legacy",
    "focus_reporting": false,
    "origin_mode": false,
    "auto_wrap": false
  },
  "attention": {
    "unread_count": 0,
    "requires_user": false,
    "reason": "background_output"
  }
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated November 12, 2026.