返回接口目录
练习复盘/Bearer

Read review snapshot

Read a paginated immutable review snapshot for one exact standalone practice record or one completed mock section, including answers, grading facts, evidence anchors, and optional bounded source material for local Agent analysis.

Endpoint

POST/api/v1/agent/capabilities/ielts_review_read_snapshot

请求参数

字段类型必填说明
includeMaterialbooleanInclude a bounded snapshot of the completed part's original material when local evidence analysis needs it.
limitnumberMaximum review items returned in this page.
maxMaterialCharsnumberMaximum combined characters returned for original material.
offsetnumberPagination offset returned by the preceding review call.
scopeincorrect | allReturn incorrect objective items, or every available submitted response.
targetunknownExact review target returned by review.recent_activity.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_review_read_snapshot' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"includeMaterial":false,"limit":6,"maxMaterialChars":12000,"offset":0,"scope":"incorrect","target":"<target>"}'

请求结构

{
  "type": "object",
  "properties": {
    "includeMaterial": {
      "default": false,
      "description": "Include a bounded snapshot of the completed part's original material when local evidence analysis needs it.",
      "type": "boolean"
    },
    "limit": {
      "default": 6,
      "description": "Maximum review items returned in this page.",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "maxMaterialChars": {
      "default": 12000,
      "description": "Maximum combined characters returned for original material.",
      "type": "integer",
      "minimum": 1000,
      "maximum": 30000
    },
    "offset": {
      "default": 0,
      "description": "Pagination offset returned by the preceding review call.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000
    },
    "scope": {
      "default": "incorrect",
      "description": "Return incorrect objective items, or every available submitted response.",
      "type": "string",
      "enum": [
        "incorrect",
        "all"
      ]
    },
    "target": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "practice"
            },
            "sessionId": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "kind",
            "sessionId"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "mock_section"
            },
            "sessionId": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "subject": {
              "type": "string",
              "enum": [
                "listening",
                "reading",
                "speaking",
                "writing"
              ]
            }
          },
          "required": [
            "kind",
            "sessionId",
            "subject"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Exact review target returned by review.recent_activity."
    }
  },
  "required": [
    "includeMaterial",
    "limit",
    "maxMaterialChars",
    "offset",
    "scope",
    "target"
  ],
  "additionalProperties": false
}

统一响应

接口结果位于 data;code 为 0 表示调用成功。

{
  "code": 0,
  "data": {},
  "message": "ok"
}

错误码

40040001请求参数不符合接口契约
40140101缺少或使用了无效的访问令牌
40340301访问令牌不包含接口所需权限
40440401接口或目标资源不存在