> ## 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. # 查询笔迹保存结果 > 用提交时的 `requestId` 查同一笔操作的最终结果。 `settled` 为真只说明返回调已返回，还要分别看 `outcome`、`persistedSnapshotVerified` 与 `snapshotCurrent`。`snapshotCurrent` 只描述返回调返回时的状态。 受理之后才出现的失败码走响应里的 `code`，不走错误对象里的 `code`。 查不到记录时返回 `404`，说明本进程里没有这笔，不等于没有保存过。 ## OpenAPI ````yaml /openapi/plugin-api.yaml post /writing/pencil-result 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: /writing/pencil-result: post: tags: - 手写会话 summary: 查询笔迹保存结果 description: | 用提交时的 `requestId` 查同一笔操作的最终结果。 `settled` 为真只说明返回调已返回，还要分别看 `outcome`、`persistedSnapshotVerified` 与 `snapshotCurrent`。`snapshotCurrent` 只描述返回调返回时的状态。 受理之后才出现的失败码走响应里的 `code`，不走错误对象里的 `code`。 查不到记录时返回 `404`，说明本进程里没有这笔，不等于没有保存过。 operationId: postWritingPencilResult requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WritingPencilResultRequest' examples: sameId: summary: 查询同一次请求 value: requestId: 9F8E7D6C-5B4A-4938-8271-6F5E4D3C2B1A responses: '200': description: 结果。受理之后的失败码在响应的 `code` 上。 content: application/json: schema: $ref: '#/components/schemas/WritingResultResponse' examples: assembled: summary: 构造示例，未实测 value: settled: true outcome: entered persistedSnapshotVerified: true snapshotCurrent: true ready: false canSwitch: false measured: summary: 实测于 2026-10-07，App 0.91 value: schemaVersion: 1 state: finished currentness: at-native-callback-only ready: false surfaceId: 8D01BA73-1CF6-4E6B-BCF1-9378B108C16B bridgeApiVersion: '0.91' inputGate: scope: application-ui-only state: released programmaticNavigationBlocked: false grantsCallerLease: false topicid: 449C1665-E0DD-4A20-9E67-2B0D451F746D scope: document-pencil-snapshot-only requestId: 78E0BE17-6C0A-4C4B-8D48-48AC4E4CE160 windowId: 287538A6-9249-4FD6-B026-493466471716 receipt: code: WRITING_CANVAS_AMBIGUOUS outcome: rejected settled: false uiInputProtected: true ready: false inputGateEndReason: released canSwitch: false target: pageNo: 1 storageBookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 storagePage: 1 bookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 storageTopicId: B1F2A354-125A-4384-A271-C0B829AB9E09 layerId: '' topicid: 449C1665-E0DD-4A20-9E67-2B0D451F746D inputFrozen: false includesNonPencilEditors: false durability: process-local-operation-record '404': $ref: '#/components/responses/NotFound' x-codeSamples: - lang: javascript label: 查询结果 source: | const r = await mn.api('/writing/pencil-result', { method: 'POST', body: { requestId } }); if (r.error && r.error.code === 'NOT_FOUND') { // 本进程里没有该笔，MarginNote 重启过；不要视为没有保存 } if (r.layerLeaseUnresolved) { // 有租约悬留，结果不确定，不要自动重试 } components: schemas: WritingPencilResultRequest: type: object required: - requestId properties: windowId: type: string expectedTopicId: type: string requestId: type: string description: 与提交时同一个标识。 WritingResultResponse: type: object description: >- 提交类操作的最终结果。看 `settled`、`outcome`、`persistedSnapshotVerified` 与 `snapshotCurrent`，不要只看 HTTP 状态码。 properties: state: type: string description: 受理时是 `pending`。 settled: type: boolean outcome: type: string persistedSnapshotVerified: type: boolean snapshotCurrent: type: boolean ready: type: boolean canSwitch: type: boolean layerLeaseUnresolved: type: boolean description: 本次调用是否让一条手写层租约悬留。为 `true` 时结果不确定，不要自动重试，先读取状态。 code: type: string description: 受理之后才出现的失败码，走该项而不是 `error.code`。 scope: type: string 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: NotFound: description: 目标对象不存在，或调用方所在的旧版 MarginNote 没有注册该接口。 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: notFound: summary: 目标不存在或接口未注册 value: error: code: NOT_FOUND message: 找不到目标对象。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.