> ## 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.

# 列出文档文件夹

> 列出文档文件夹。文件夹是文档根目录下的真实目录，层级用 `/` 分隔，根目录传空串。

文件夹与学习集互不影响。给文档分类还有另一种方式是标签，与该接口无关。




## OpenAPI

````yaml /openapi/plugin-api.yaml get /library/folders
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:
  /library/folders:
    get:
      tags:
        - 查找
      summary: 列出文档文件夹
      description: |
        列出文档文件夹。文件夹是文档根目录下的真实目录，层级用 `/` 分隔，根目录传空串。

        文件夹与学习集互不影响。给文档分类还有另一种方式是标签，与该接口无关。
      operationId: getLibraryFolders
      parameters:
        - $ref: '#/components/parameters/PathQuery'
        - $ref: '#/components/parameters/Depth'
      responses:
        '200':
          description: 响应字段没有依据。
          content:
            application/json:
              schema:
                type: object
                properties:
                  bridgeApiVersion:
                    type: string
                  next:
                    type: string
                  root:
                    type: string
                  depth:
                    type: integer
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        name:
                          type: string
                        depth:
                          type: integer
                      required:
                        - path
                        - name
                        - depth
              examples:
                measured:
                  summary: 实测于 2026-10-07，App 0.91
                  value:
                    bridgeApiVersion: '0.91'
                    next: >-
                      Folders are plain directories under MarginNote's
                      Documents. "" is the root. A document's folder is
                      independent of which study sets reference it — moving it
                      between folders does not break those links.
                    root: ''
                    depth: 3
                    folders:
                      - path: ChatMemories
                        name: ChatMemories
                        depth: 1
                      - path: ImmersiveTemplates
                        name: ImmersiveTemplates
                        depth: 1
                      - path: Imported Pages
                        name: Imported Pages
                        depth: 1
                      - path: ImportEverythingExports
                        name: ImportEverythingExports
                        depth: 1
                      - path: QuizPort
                        name: QuizPort
                        depth: 1
                      - path: TemplateSamples
                        name: TemplateSamples
                        depth: 1
                      - path: ImportEverythingExports/BilibiliVideos
                        name: BilibiliVideos
                        depth: 2
                      - path: TemplateSamples/mn.guide
                        name: mn.guide
                        depth: 2
                      - path: TemplateSamples/u-exam-card-practice
                        name: u-exam-card-practice
                        depth: 2
                      - path: TemplateSamples/u-vocab-reader
                        name: u-vocab-reader
                        depth: 2
      x-codeSamples:
        - lang: javascript
          label: 列出根目录下的文件夹
          source: |
            const r = await mn.api('/library/folders?path=');
            mn.log(r);
components:
  parameters:
    PathQuery:
      name: path
      in: query
      required: false
      description: 相对包根或文档根的路径，层级用 `/` 分隔。带该参数时返回一份文件的原始内容，不再返回清单。
      schema:
        type: string
    Depth:
      name: depth
      in: query
      required: false
      description: 向下展开的层数。
      schema:
        type: integer
        minimum: 0

````

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