> ## 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. # 获取操作上下文 > 返回当前打开的学习集与文档、当前页、选中的卡与焦点卡。与 `GET /ui-state` 的分工： 该接口返回整理过的语义，`/ui-state` 返回界面自己的键值。 无法获取信息时仍返回 `200`，`available` 为 `false`，原因见 `reason`。 ## OpenAPI ````yaml /openapi/plugin-api.yaml get /context 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: /context: get: tags: - 能力与状态 summary: 获取操作上下文 description: | 返回当前打开的学习集与文档、当前页、选中的卡与焦点卡。与 `GET /ui-state` 的分工： 该接口返回整理过的语义，`/ui-state` 返回界面自己的键值。 无法获取信息时仍返回 `200`，`available` 为 `false`，原因见 `reason`。 operationId: getContext responses: '200': description: 当前上下文。 content: application/json: schema: type: object properties: documents: type: array items: type: object properties: pageKind: type: string pageMappingAvailable: type: boolean bookmd5: type: string pageBookmd5: type: string title: type: string surfacePage: type: integer page: type: integer focused: type: boolean selectedNotes: type: array items: type: string description: 实测为空数组，条目结构没有依据。 available: type: boolean currentPage: type: object properties: linked: type: boolean containerBookmd5: type: string bookmd5: type: string mappingAvailable: type: boolean surfacePage: type: integer kind: type: string page: type: integer blankPage: type: string description: ⚠️ next: type: string studySet: type: object properties: topicid: type: string title: type: string isDeck: type: boolean focusedNote: description: 实测为 null。什么情况下返回非空，尚无依据。 capturedAt: type: string template: type: object properties: id: type: string detail: type: string immersive: type: boolean name: type: string builtIn: type: boolean bridgeApiVersion: type: string reason: type: string description: ⚠️获取不到时的原因。 enum: - nothing_open - app_not_responding - window_unavailable - read_failed examples: assembled: summary: 构造示例，未实测 value: available: true studySet: isDeck: false currentPage: bookmd5: >- 8daef026f17a04db9b325c86366419936de1ef8b454218998990a3cef6f467a7 page: 6 mappingAvailable: true focusedNote: '' capturedAt: '2026-10-06T15:51:30Z' template: id: reading-vocabulary name: 外刊生词 builtIn: false immersive: true measured: summary: 实测于 2026-10-07，App 0.91 value: documents: - pageKind: document pageMappingAvailable: true bookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 pageBookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 title: The Quiet Case for Walkable Streets surfacePage: 1 page: 1 focused: true selectedNotes: [] available: true currentPage: linked: false containerBookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 bookmd5: >- ec280b8dbd77594d16b090165fdd4c07ec280b8dbd77594d16b090165fdd4c07 mappingAvailable: true surfacePage: 1 kind: document page: 1 next: >- This is a snapshot of the moment you asked, not of when the user spoke — they may have moved on. Read the titles back to the user before acting on anything destructive. studySet: topicid: 449C1665-E0DD-4A20-9E67-2B0D451F746D title: The Quiet Case for Walkable Streets isDeck: false focusedNote: null capturedAt: '2026-10-07T09:32:23Z' template: id: u-api-probe detail: /immersive/template immersive: true name: 接口探针 builtIn: false bridgeApiVersion: '0.91' x-codeSamples: - lang: javascript label: 获取当前打开的学习集 source: | const ctx = await mn.api('/context'); if (!ctx.available) mn.log('取不到上下文：' + ctx.reason); ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.