> ## 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. # 创建摘录 > 用一把摘录工具或一个划线快捷项，在文档的指定位置摘一条。摘录走模板配置的流程， 摘出来的卡带上工具配置好的标签、颜色与 AI 归属。 工具序号取自 `GET /immersive/template` 响应里 `excerptTools.tools[].index`， 与 `shortcutIndex` 二者取一。 响应里有两个 id：`noteid` 指向文档笔记本里的记录，`cardNoteId` 指向脑图上的卡片。 插件状态记在后者上。 ## OpenAPI ````yaml /openapi/plugin-api.yaml post /excerpts 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: /excerpts: post: tags: - 卡片与摘录 summary: 创建摘录 description: | 用一把摘录工具或一个划线快捷项，在文档的指定位置摘一条。摘录走模板配置的流程， 摘出来的卡带上工具配置好的标签、颜色与 AI 归属。 工具序号取自 `GET /immersive/template` 响应里 `excerptTools.tools[].index`， 与 `shortcutIndex` 二者取一。 响应里有两个 id：`noteid` 指向文档笔记本里的记录，`cardNoteId` 指向脑图上的卡片。 插件状态记在后者上。 operationId: postExcerpts requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExcerptsRequest' examples: byTool: summary: 用第 2 把工具创建摘录 value: bookmd5: >- 8daef026f17a04db9b325c86366419936de1ef8b454218998990a3cef6f467a7 page: 12 rect: x: 82.5 'y': 143.2 width: 410.8 height: 62.4 toolIndex: 2 confirm: true responses: '200': description: 响应。可能还有未列出的字段。 content: application/json: schema: type: object properties: noteid: type: string description: 文档笔记本里那一条。 tool: type: object properties: index: type: integer addToMap: type: boolean aiOCRPromptChars: type: integer label: type: string aiAddon: type: string highlightMode: type: integer fillIndex: type: integer colorIndex: type: integer aiOCR: type: boolean insertAfterFocus: type: boolean structuredAIOCR: type: boolean hashtag: type: string usedList: type: string next: type: string description: 提示异步生成内容的等待方式。 cardNoteId: type: string description: 脑图上的卡片。插件状态记在该卡上。 page: type: integer bridgeApiVersion: type: string topicid: type: string duplicateAt: type: array description: ⚠️同一个位置上已有的其他摘录。 items: type: string warning: type: string description: ⚠️ examples: assembled: summary: 构造示例，未实测 value: noteid: 8BD59972-D471-4BF0-A244-9F6F2B9F99F1 cardNoteId: B9F3696A-AF8A-43B2-A8A2-2791717F1695 duplicateAt: [] measured: summary: 实测于 2026-10-07，App 0.91 value: noteid: 48FECCDA-BA29-477F-9B9D-B5B44D5FB051 tool: index: 0 addToMap: true aiOCRPromptChars: 0 label: '' aiAddon: '' highlightMode: 1 fillIndex: 0 colorIndex: 4 aiOCR: false insertAfterFocus: true structuredAIOCR: false hashtag: '' usedList: excerptTools next: >- 'Read plugin state on cardNoteId, NOT on noteid: noteid is the excerpt in the document notebook, cardNoteId is the card in the study set, and plugin metadata lives on the card. Excerpt text is filled in asynchronously; re-read with POST /notes/batch-get if it still looks empty.' cardNoteId: D3085422-2CB9-4B68-A78D-DEE351CF9C38 page: 1 bridgeApiVersion: '0.91' topicid: B1F2A354-125A-4384-A271-C0B829AB9E09 '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/UnprocessableEntity' x-codeSamples: - lang: javascript label: 用模板里的第一把工具摘一条 source: | const t = await mn.api('/immersive/template'); const tool = t.excerptTools.tools[0]; const r = await mn.api('/excerpts', { method: 'POST', body: { bookmd5, page, rect: { x: 82.5, y: 143.2, width: 410.8, height: 62.4 }, toolIndex: tool.index, confirm: true } }); // 插件状态记在 cardNoteId 上，不是 noteid mn.log(r.cardNoteId); components: schemas: ExcerptsRequest: type: object required: - bookmd5 - page - rect - confirm properties: bookmd5: type: string description: 要摘的文档。 page: type: integer minimum: 1 description: PDF 页序。 rect: $ref: '#/components/schemas/PageRect' toolIndex: type: integer description: >- 摘录工具的序号。取自 `GET /immersive/template` 响应 `excerptTools.tools[].index`。与 `shortcutIndex` 二者取一。 shortcutIndex: type: integer description: 划线快捷项的序号。与 `toolIndex` 二者取一。 confirm: type: boolean description: 必填。由 MarginNote 自动补上。 PageRect: type: object required: - x - 'y' - width - height description: PDF 页坐标。 properties: x: type: number 'y': type: number width: type: number height: type: number ErrorEnvelope: type: object description: >- 失败时的 Response Body。MarginNote 将其当作正常 Response Body 返回，因此落在 resolve 里而不是 reject 里。 required: - error properties: error: $ref: '#/components/schemas/ErrorObject' ErrorObject: type: object required: - code - message properties: code: type: string description: 错误码。判断写入是否发生看该字段，不看 HTTP 状态码。 message: type: string description: 人可读的说明。文案随 MarginNote 的版本变化，不要用该字段做分支判断。 retryable: type: boolean description: >- 是否明确可以稍后再试。只有外部调用的响应带该字段，面板本地调用的响应只有 `code` 与 `message`。该布尔值表达不了结果未定，这类情况按各接口的说明处理，例如手写会话族看响应里的 `layerLeaseUnresolved`。 details: type: object description: >- 附加事实。例如 `SCAN_BUSY` 带 `retryAfterSeconds`，`HASHTAG_ROUTE_REQUIRED` 带 `writeRoute`。 additionalProperties: true responses: Conflict: description: 读取到写入之间的这段时间里目标被改过，本次调用没有写入任何内容。 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: contentChanged: summary: 内容已被改过 value: error: code: CONTENT_CHANGED message: 目标内容在这期间被改过，请重读后再发。 UnprocessableEntity: description: 字段合法但组合不成立，例如缺少 `confirm`、序号越界、或写入顺序违反约定。 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: confirmRequired: summary: 没有带 confirm value: error: code: CONFIRM_REQUIRED message: 本次调用会改动数据，需要带 confirm。 invalidOrder: summary: 写入顺序不成立 value: error: code: INVALID_ORDER message: deleteComment 必须排在 removeHashtags 之前。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.