> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# lists.captureTemplate

> Advanced alias for lists.getStyle. Capture list formatting from the abstract definition only (does not merge lvlOverride formatting).

## Summary

Advanced alias for lists.getStyle. Capture list formatting from the abstract definition only (does not merge lvlOverride formatting).

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

## Expected result

Returns a ListsCaptureTemplateResult containing the captured template.

## Input fields

| Field             | Type            | Required | Description            |
| ----------------- | --------------- | -------- | ---------------------- |
| `levels`          | integer\[]      | no       |                        |
| `target`          | ListItemAddress | yes      | ListItemAddress        |
| `target.kind`     | `"block"`       | yes      | Constant: `"block"`    |
| `target.nodeId`   | string          | yes      |                        |
| `target.nodeType` | `"listItem"`    | yes      | Constant: `"listItem"` |

### Example request

```json theme={null}
{
  "levels": [
    1
  ],
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  }
}
```

## Output fields

### Variant 1 (success=true)

| Field              | Type      | Required | Description      |
| ------------------ | --------- | -------- | ---------------- |
| `success`          | `true`    | yes      | Constant: `true` |
| `template`         | object    | yes      |                  |
| `template.levels`  | object\[] | yes      |                  |
| `template.version` | `1`       | yes      | Constant: `1`    |

### Variant 2 (success=false)

| Field             | Type    | Required | Description                                                   |
| ----------------- | ------- | -------- | ------------------------------------------------------------- |
| `failure`         | object  | yes      |                                                               |
| `failure.code`    | enum    | yes      | `"INVALID_TARGET"`, `"INVALID_INPUT"`, `"LEVEL_OUT_OF_RANGE"` |
| `failure.details` | any     | no       |                                                               |
| `failure.message` | string  | yes      |                                                               |
| `success`         | `false` | yes      | Constant: `false`                                             |

### Example response

```json theme={null}
{
  "success": true,
  "template": {
    "levels": [
      {
        "level": 1,
        "lvlText": "example",
        "numFmt": "example"
      }
    ],
    "version": 1
  }
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `INVALID_TARGET`
* `INVALID_INPUT`

## Non-applied failure codes

* `INVALID_TARGET`
* `INVALID_INPUT`
* `LEVEL_OUT_OF_RANGE`

## Raw schemas

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "levels": {
        "items": {
          "maximum": 8,
          "minimum": 0,
          "type": "integer"
        },
        "type": "array"
      },
      "target": {
        "$ref": "#/$defs/ListItemAddress"
      }
    },
    "required": [
      "target"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "oneOf": [
      {
        "additionalProperties": false,
        "properties": {
          "success": {
            "const": true
          },
          "template": {
            "additionalProperties": false,
            "properties": {
              "levels": {
                "items": {
                  "additionalProperties": false,
                  "properties": {
                    "alignment": {
                      "enum": [
                        "left",
                        "center",
                        "right"
                      ]
                    },
                    "indents": {
                      "additionalProperties": false,
                      "properties": {
                        "firstLine": {
                          "type": "integer"
                        },
                        "hanging": {
                          "type": "integer"
                        },
                        "left": {
                          "type": "integer"
                        }
                      },
                      "type": "object"
                    },
                    "level": {
                      "maximum": 8,
                      "minimum": 0,
                      "type": "integer"
                    },
                    "lvlText": {
                      "type": "string"
                    },
                    "markerFont": {
                      "type": "string"
                    },
                    "numFmt": {
                      "type": "string"
                    },
                    "pictureBulletId": {
                      "type": "integer"
                    },
                    "start": {
                      "type": "integer"
                    },
                    "trailingCharacter": {
                      "enum": [
                        "tab",
                        "space",
                        "nothing"
                      ]
                    }
                  },
                  "required": [
                    "level"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "version": {
                "const": 1
              }
            },
            "required": [
              "version",
              "levels"
            ],
            "type": "object"
          }
        },
        "required": [
          "success",
          "template"
        ],
        "type": "object"
      },
      {
        "additionalProperties": false,
        "properties": {
          "failure": {
            "additionalProperties": false,
            "properties": {
              "code": {
                "enum": [
                  "INVALID_TARGET",
                  "INVALID_INPUT",
                  "LEVEL_OUT_OF_RANGE"
                ]
              },
              "details": {},
              "message": {
                "type": "string"
              }
            },
            "required": [
              "code",
              "message"
            ],
            "type": "object"
          },
          "success": {
            "const": false
          }
        },
        "required": [
          "success",
          "failure"
        ],
        "type": "object"
      }
    ]
  }
  ```
</Accordion>

<Accordion title="Raw success schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "success": {
        "const": true
      },
      "template": {
        "additionalProperties": false,
        "properties": {
          "levels": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "alignment": {
                  "enum": [
                    "left",
                    "center",
                    "right"
                  ]
                },
                "indents": {
                  "additionalProperties": false,
                  "properties": {
                    "firstLine": {
                      "type": "integer"
                    },
                    "hanging": {
                      "type": "integer"
                    },
                    "left": {
                      "type": "integer"
                    }
                  },
                  "type": "object"
                },
                "level": {
                  "maximum": 8,
                  "minimum": 0,
                  "type": "integer"
                },
                "lvlText": {
                  "type": "string"
                },
                "markerFont": {
                  "type": "string"
                },
                "numFmt": {
                  "type": "string"
                },
                "pictureBulletId": {
                  "type": "integer"
                },
                "start": {
                  "type": "integer"
                },
                "trailingCharacter": {
                  "enum": [
                    "tab",
                    "space",
                    "nothing"
                  ]
                }
              },
              "required": [
                "level"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "version": {
            "const": 1
          }
        },
        "required": [
          "version",
          "levels"
        ],
        "type": "object"
      }
    },
    "required": [
      "success",
      "template"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw failure schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "failure": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "enum": [
              "INVALID_TARGET",
              "INVALID_INPUT",
              "LEVEL_OUT_OF_RANGE"
            ]
          },
          "details": {},
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ],
        "type": "object"
      },
      "success": {
        "const": false
      }
    },
    "required": [
      "success",
      "failure"
    ],
    "type": "object"
  }
  ```
</Accordion>