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

Search IELTS knowledge articles

Search published IELTS Buddy prep guides by keyword or tag. Results are paginated and include a stable prep_guide contentRef. This is the prep-guide module's only search interface.

Endpoint

POST/api/v1/agent/capabilities/ielts_prep_search_guides

请求参数

字段类型必填说明
limitnumberResult limit, 1-8.
offsetnumberPagination offset.
querystringKeyword or title.
tagstringOptional published guide tag or category.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_prep_search_guides' \
  -H 'Content-Type: application/json' \
  --data '{"limit":8,"offset":0,"query":"","tag":""}'

请求结构

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 8,
      "description": "Result limit, 1-8.",
      "type": "integer",
      "minimum": 1,
      "maximum": 8
    },
    "offset": {
      "default": 0,
      "description": "Pagination offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "query": {
      "default": "",
      "description": "Keyword or title.",
      "type": "string"
    },
    "tag": {
      "default": "",
      "description": "Optional published guide tag or category.",
      "type": "string"
    }
  },
  "required": [
    "limit",
    "offset",
    "query",
    "tag"
  ],
  "additionalProperties": false
}

统一响应

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

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

错误码

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