> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-nick-sd-2099-images-core-lifecycle-placement-seman.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# info

> Return document metadata including revision, node count, and capabilities.

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Return document metadata including revision, node count, and capabilities.

* Operation ID: `info`
* API member path: `editor.doc.info(...)`
* Mutates document: `no`
* Idempotency: `idempotent`
* Supports tracked mode: `no`
* Supports dry run: `no`
* Deterministic target resolution: `yes`

## Expected result

Returns a DocumentInfo object with revision, word/paragraph/heading counts, and capability flags.

## Input fields

*No fields.*

### Example request

```json theme={null}
{}
```

## Output fields

| Field                     | Type      | Required | Description |
| ------------------------- | --------- | -------- | ----------- |
| `capabilities`            | object    | yes      |             |
| `capabilities.canComment` | boolean   | yes      |             |
| `capabilities.canFind`    | boolean   | yes      |             |
| `capabilities.canGetNode` | boolean   | yes      |             |
| `capabilities.canReplace` | boolean   | yes      |             |
| `counts`                  | object    | yes      |             |
| `counts.comments`         | integer   | yes      |             |
| `counts.headings`         | integer   | yes      |             |
| `counts.images`           | integer   | yes      |             |
| `counts.paragraphs`       | integer   | yes      |             |
| `counts.tables`           | integer   | yes      |             |
| `counts.words`            | integer   | yes      |             |
| `outline`                 | object\[] | yes      |             |
| `revision`                | string    | yes      |             |

### Example response

```json theme={null}
{
  "capabilities": {
    "canComment": true,
    "canFind": true,
    "canGetNode": true,
    "canReplace": true
  },
  "counts": {
    "comments": 0,
    "headings": 3,
    "images": 2,
    "paragraphs": 12,
    "tables": 1,
    "words": 250
  },
  "outline": [
    {
      "level": 1,
      "nodeId": "node-def456",
      "text": "Hello, world."
    }
  ],
  "revision": "example"
}
```

## Pre-apply throws

* None

## Non-applied failure codes

* None

## Raw schemas

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {},
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "capabilities": {
        "additionalProperties": false,
        "properties": {
          "canComment": {
            "type": "boolean"
          },
          "canFind": {
            "type": "boolean"
          },
          "canGetNode": {
            "type": "boolean"
          },
          "canReplace": {
            "type": "boolean"
          }
        },
        "required": [
          "canFind",
          "canGetNode",
          "canComment",
          "canReplace"
        ],
        "type": "object"
      },
      "counts": {
        "additionalProperties": false,
        "properties": {
          "comments": {
            "type": "integer"
          },
          "headings": {
            "type": "integer"
          },
          "images": {
            "type": "integer"
          },
          "paragraphs": {
            "type": "integer"
          },
          "tables": {
            "type": "integer"
          },
          "words": {
            "type": "integer"
          }
        },
        "required": [
          "words",
          "paragraphs",
          "headings",
          "tables",
          "images",
          "comments"
        ],
        "type": "object"
      },
      "outline": {
        "items": {
          "additionalProperties": false,
          "properties": {
            "level": {
              "type": "integer"
            },
            "nodeId": {
              "type": "string"
            },
            "text": {
              "type": "string"
            }
          },
          "required": [
            "level",
            "text",
            "nodeId"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "revision": {
        "type": "string"
      }
    },
    "required": [
      "counts",
      "outline",
      "capabilities",
      "revision"
    ],
    "type": "object"
  }
  ```
</Accordion>