返回接口目录
备考内容/Public

Read IELTS knowledge article

Read one full published IELTS Buddy knowledge article by slug.

Endpoint

POST/api/v1/agent/capabilities/ielts_prep_read_guide

请求参数

字段类型必填说明
maxCharsnumberMaximum article characters to return.
offsetnumberCharacter offset returned by the preceding read.
slugstringPublished prep guide slug.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_prep_read_guide' \
  -H 'Content-Type: application/json' \
  --data '{"maxChars":12000,"offset":0,"slug":"guide-slug"}'

请求结构

{
  "type": "object",
  "properties": {
    "maxChars": {
      "default": 12000,
      "description": "Maximum article characters to return.",
      "type": "integer",
      "minimum": 1000,
      "maximum": 30000
    },
    "offset": {
      "default": 0,
      "description": "Character offset returned by the preceding read.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "slug": {
      "type": "string",
      "minLength": 1,
      "description": "Published prep guide slug."
    }
  },
  "required": [
    "maxChars",
    "offset",
    "slug"
  ],
  "additionalProperties": false
}

统一响应

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

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

错误码

40040001请求参数不符合接口契约
40440401接口或目标资源不存在