> ## 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 post /writing/blank-enter
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/blank-enter:
    post:
      tags:
        - 手写会话
      summary: 进入留白作答
      description: 进入题目对应的留白作答位置。该接口可能触发窗口转场，调用后应查询转场结果。
      operationId: postWritingBlankEnter
      requestBody:
        $ref: '#/components/requestBodies/WritingTransitionCommand'
      responses:
        '200':
          description: 转场结果。可能还有未列出的字段。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WritingTransitionResponse'
              examples:
                accepted:
                  summary: 构造示例，转场已受理
                  value:
                    schemaVersion: 1
                    bridgeApiVersion: '0.91'
                    requestId: 9F8E7D6C-5B4A-4938-8271-6F5E4D3C2B1A
                    state: pending
                    settled: false
                    outcome: accepted
                    ready: false
                    canSwitch: false
                    scope: current-window
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-codeSamples:
        - lang: javascript
          label: 进入留白作答
          source: |
            const r = await mn.api('/writing/blank-enter', {
              method: 'POST',
              body: { requestId, questionId, carrier: 'blank', confirm: true }
            });
            if (r.error) mn.log(r.error.code);
components:
  requestBodies:
    WritingTransitionCommand:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WritingTransitionRequest'
          examples:
            focus:
              summary: 进入焦点卡作答
              value:
                requestId: 9F8E7D6C-5B4A-4938-8271-6F5E4D3C2B1A
                questionId: D3085422-2CB9-4B68-A78D-DEE351CF9C38
                confirm: true
  schemas:
    WritingTransitionResponse:
      type: object
      description: 作答转场结果。看 `settled`、`outcome`、`ready` 与 `canSwitch`，不要只看 HTTP 状态码。
      properties:
        schemaVersion:
          type: integer
        bridgeApiVersion:
          type: string
        requestId:
          type: string
        state:
          type: string
          description: 受理时可能为 `pending`。
        settled:
          type: boolean
        outcome:
          type: string
        ready:
          type: boolean
        canSwitch:
          type: boolean
        scope:
          type: string
        code:
          type: string
          description: 受理之后才出现的失败码，走该项而不是 `error.code`。
        layerLeaseUnresolved:
          type: boolean
          description: 为 `true` 时结果不确定，不要自动重试，先读取状态。
      additionalProperties: true
    WritingTransitionRequest:
      type: object
      description: 作答转场命令的公共输入。不同路由会读取其中一部分字段。
      properties:
        windowId:
          type: string
        expectedTopicId:
          type: string
        requestId:
          type: string
          description: 调用方生成的幂等标识。后续查询 `transition-result` 时使用。
        questionId:
          type: string
          description: 要进入或开始作答的题目。
        carrier:
          type: string
          description: 作答载体，例如 `focus` 或 `blank`。
        runId:
          type: string
        attemptId:
          type: string
        confirm:
          type: boolean
          description: 写操作确认。面板调用时 MarginNote 会补上。
      additionalProperties: true
    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:
    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.