---
title: "block.read: Read a block — Note kit command — Kition"
description: "Answers the Markdown of the block carrying the block id `blockId` (`^id`), with its range and first line."
canonical: "https://developer.kition.ai/docs/kits/note/commands/block.read"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/note/commands/block.read](https://developer.kition.ai/docs/kits/note/commands/block.read)

# block.read

**Read a block.** Answers the Markdown of the block carrying the block id `blockId` (`^id`), with its range and first line.

- Kit: Note 0.3.0 (Markdown (.md)); reference: [Note kit commands](https://developer.kition.ai/docs/kits/note.md)
- Changes the document: no

## Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blockId` | `string` | yes | The block id, without the caret (^). |
| `unit` | `"scalar" \| "utf16"` | no | How positions are counted: Unicode characters (scalar, the default), or UTF-16 code units as the editor counts them. |

## Call through note_run

```text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "block.read", "params": { "blockId": <string> } }]
}
```

The required parameters, with placeholders for their types: not a tested example. Optional: `unit`. note_run answers the step’s result in `completed[i].result`.

## Result

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `from` | `integer` | yes | Where it starts, in the request's unit. |
| `line` | `integer` | yes | Its first line, from 1. |
| `markdown` | `string` | yes | The Markdown, as the file has it. |
| `to` | `integer` | yes | Where it ends (exclusive). |

```json
{
  "additionalProperties": false,
  "properties": {
    "from": {
      "description": "Where it starts, in the request's unit.",
      "type": "integer"
    },
    "line": {
      "description": "Its first line, from 1.",
      "type": "integer"
    },
    "markdown": {
      "description": "The Markdown, as the file has it.",
      "type": "string"
    },
    "to": {
      "description": "Where it ends (exclusive).",
      "type": "integer"
    }
  },
  "required": [
    "from",
    "line",
    "markdown",
    "to"
  ],
  "type": "object"
}
```

## Parameter schema

```json
{
  "additionalProperties": false,
  "properties": {
    "blockId": {
      "description": "The block id, without the caret (^).",
      "type": "string"
    },
    "unit": {
      "default": "scalar",
      "description": "How positions are counted: Unicode characters (scalar, the default), or UTF-16 code units as the editor counts them.",
      "enum": [
        "scalar",
        "utf16"
      ],
      "type": "string"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
```

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9).
