> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取文档目录

> 读文档的章节目录与各自的页范围，用于按章取内容。

响应里的页数是 PDF 页序，与书上印的页码不是一返回事。`pageCount` 仅供参考，
文档离屏打开失败时会给 0。




## OpenAPI

````yaml /openapi/plugin-api.yaml get /documents/{bookmd5}/outline
openapi: 3.1.0
info:
  title: 场景插件 API
  summary: 场景插件在网页面板里可以调用的接口。
  description: >
    场景插件的面板是一个网页。页面里向 `/bridge/v1` 发请求，就能读写 MarginNote 里的数据。

    请求由 MarginNote 处理，与外部命令行工具共用同一套处理代码。外部工具要带令牌，面板不必带。

    面板页面从 `mnpanel://panel/index.html` 加载，因此 `fetch('/bridge/v1' + path)`
    属于同源请求。


    面板调用受这些条件约束：


    - 请求不带令牌，本文件也不声明安全方案。

    - 页面能调用哪些接口，取决于两份名单。模板里的 `plugins` 名单和沉浸态决定面板能不能建好，
      网页面板白名单决定页面能调哪些接口。不在白名单里的请求返回 `403`，
      错误码为 `IN_PROCESS_NOT_ALLOWED`。
    - `GET /capabilities` 里的 `requiresMax` 只约束外部 Agent。面板的请求在 MarginNote 进程内处理，
      不受令牌、订阅状态与跨设备批准的限制，能否调用只看该路径是否在白名单内。
    - 写操作里的 `addon`，MarginNote 会改写为当前面板所属插件的 id；`confirm` 由 MarginNote 补上。
      页面填的值不会生效。

    用 `mn.api(path, opts)` 读取数据。该方法始终将 Response Body 按 JSON 解析，相当于

    `fetch('/bridge/v1' + path, opts).then(r => r.json())`。


    响应的内容不是 JSON 的接口，改用 `fetch`：


    - `GET /guide` 返回 Markdown 正文。

    - `GET /notes/{noteid}/render` 返回卡片长图或 PDF。

    - `GET /documents/{bookmd5}/pages/{index}/content/{contentId}` 返回图片。

    - `GET /bundles/{bundleId}/files` 带 `?path=` 时返回该文件的原始字节。


    调用失败时 Promise 不会进入 reject。MarginNote 把错误对象

    `{"error":{"code":"…","message":"…"}}` 当作 Response Body 返回，因此结果落在 resolve 里。

    判断调用结果看响应里是否带 `error`，写操作另看响应里的 `persisted`。


    接口清单、各项上限与 Request Body 结构随 MarginNote 的版本变化，运行时以 `GET /capabilities` 与

    `GET /guide` 返回的内容为准。
  version: '0.91'
servers: []
security: []
tags:
  - name: 能力与状态
    description: 读取 MarginNote 的能力、版本与当前上下文。调用其他接口之前先读这组。
  - name: 卡片与摘录
    description: 卡片的读取与写入、摘录的创建、批注、标签、元数据与留白。
  - name: 手写会话
    description: 手写层、作答纸、练习准备清单与会话记录的读取与提交。
  - name: 学习集与卡组
    description: 学习集结构、脑图树、子脑图、色板、快照与复习卡组。
  - name: 文档与页面
    description: 文档目录、页文本、页内注释面、摘录清单与同步诊断。
  - name: 导出与 Anki
    description: 文档导出计划、导出文件、Anki 导出能力、作业与产物。
  - name: 查找
    description: 跨库搜索、文件夹列表与学习集列表。
  - name: 界面与模板
    description: 读取当前界面状态与沉浸模板。
  - name: 插件辅助
    description: 面板辅助脚本、已配对设备与本机 helper 信息。
  - name: 任务包与同步诊断
    description: 拆书任务包与旧 CloudKit 同步诊断。
paths:
  /documents/{bookmd5}/outline:
    get:
      tags:
        - 文档与页面
      summary: 获取文档目录
      description: |
        读文档的章节目录与各自的页范围，用于按章取内容。

        响应里的页数是 PDF 页序，与书上印的页码不是一返回事。`pageCount` 仅供参考，
        文档离屏打开失败时会给 0。
      operationId: getDocumentsBookmd5Outline
      parameters:
        - $ref: '#/components/parameters/Bookmd5'
      responses:
        '200':
          description: 章节目录。可能还有未列出的字段。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutlineResponse'
              examples:
                assembled:
                  summary: 构造示例，未实测
                  value:
                    segments:
                      - title: 第一章 街道的账本
                        startPage: 1
                        endPage: 24
                      - title: 第二章 车道的边际成本
                        startPage: 25
                        endPage: 58
                    hasToc: true
                    pageCount: 186
                measured:
                  summary: 实测于 2026-10-07，App 0.91
                  value:
                    hasToc: false
                    bookmd5: >-
                      ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07
                    title: The Quiet Case for Walkable Streets
                    bridgeApiVersion: '0.91'
                    segments: []
                    pageCount: 2
      x-codeSamples:
        - lang: javascript
          label: 获取第一章的页范围
          source: |
            const o = await mn.api('/documents/' + bookmd5 + '/outline');
            if (!o.hasToc) { mn.log('这本书没有目录'); return; }
            const first = o.segments[0];
            mn.log(first.title, first.startPage, first.endPage);
components:
  parameters:
    Bookmd5:
      name: bookmd5
      in: path
      required: true
      description: >-
        文档的内容标识。取自 `GET /study-sets/{topicid}/documents` 响应里各项的 `bookmd5`、`GET
        /ui-state` 的 `state.bookmd5`，或 `GET /search?scope=documents`。
      schema:
        type: string
  schemas:
    OutlineResponse:
      type: object
      properties:
        segments:
          type: array
          description: 章节页范围。
          items:
            type: object
            properties:
              title:
                type: string
              startPage:
                type: number
              endPage:
                type: number
        hasToc:
          type:
            - boolean
            - integer
          description: 这本书是否有目录。较早的 MarginNote 在该项上给 `1` 与 `0`，按真值判断。
        pageCount:
          type: number
          description: 页数。离屏打开失败时会给 0，不要将该值当作准确值。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.