inkbolt_session_read
Read a current session or named snapshot to return its document, resource roots, current revision, and history depths. Use it to inspect state before editing.
Instructions
Read the current session or a named snapshot, including document, resource roots, current revision and history depths.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| snapshot | No | ||
| session_id | Yes | ||
| session_root | No | Runtime path relative to the selected workspace, or an absolute path inside it. Omitted session, receipt, job, image/font store and output roots use documented workspace defaults; explicit null retains optional-root semantics. | |
| response_mode | No | Compact returns pinned document/receipt references and summaries, omitting snapshot pixels, receipt changes and the snapshot list. Full preserves the original response. Presentation does not change durable retry identity. | full |
| response_format | No | JSON/Markdown include a metadata envelope in text. Structured/preview use summary text. All formats send PNG bytes once with payload references. | json |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| error | No | ||
| result | No |