返回接口目录
词汇/Bearer

Search personal vocabulary

Search the current user's personal vocabulary book by phrase, meaning, usage, or learning state. Results are compact and paginated. This is the personal vocabulary module's only catalog-search interface.

Endpoint

POST/api/v1/agent/capabilities/ielts_vocabulary_personal_search

请求参数

字段类型必填说明
limitnumberlimit
learningState | new | learning | review | relearning | masteredlearningState
offsetnumberoffset
querystringSearch phrase, meaning, or usage.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_vocabulary_personal_search' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"limit":20,"learningState":"","offset":0,"query":""}'

请求结构

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "learningState": {
      "default": "",
      "type": "string",
      "enum": [
        "",
        "new",
        "learning",
        "review",
        "relearning",
        "mastered"
      ]
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "query": {
      "default": "",
      "description": "Search phrase, meaning, or usage.",
      "type": "string"
    }
  },
  "required": [
    "limit",
    "learningState",
    "offset",
    "query"
  ],
  "additionalProperties": false
}

统一响应

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

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

错误码

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