返回接口目录
词汇/Bearer

Prepare built-in vocabulary cards

Prepare flashcards from an enabled licensed built-in IELTS vocabulary set.

Endpoint

POST/api/v1/agent/capabilities/ielts_vocabulary_builtin_prepare_cards

请求参数

字段类型必填说明
excludeRecentlyReviewedDaysnumberAvoid words reviewed in the last N days when possible.
groupIdstringOptional built-in wordbook group id.
includeMasteredbooleanWhether mastered words may be selected.
learningState | new | learning | review | relearning | masteredOptional learning-state filter.
limitnumberNumber of local flashcards to prepare.
modemixed | due | new | weak | randomCard selection strategy.
querystringOptional phrase, meaning, or usage search filter.
setIdcore | listening | readingBuilt-in wordbook id.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_vocabulary_builtin_prepare_cards' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"excludeRecentlyReviewedDays":3,"groupId":"","includeMastered":false,"learningState":"","limit":8,"mode":"mixed","query":"","setId":"core"}'

请求结构

{
  "type": "object",
  "properties": {
    "excludeRecentlyReviewedDays": {
      "default": 3,
      "description": "Avoid words reviewed in the last N days when possible.",
      "type": "integer",
      "minimum": 0,
      "maximum": 90
    },
    "groupId": {
      "default": "",
      "description": "Optional built-in wordbook group id.",
      "type": "string"
    },
    "includeMastered": {
      "default": false,
      "description": "Whether mastered words may be selected.",
      "type": "boolean"
    },
    "learningState": {
      "default": "",
      "description": "Optional learning-state filter.",
      "type": "string",
      "enum": [
        "",
        "new",
        "learning",
        "review",
        "relearning",
        "mastered"
      ]
    },
    "limit": {
      "default": 8,
      "description": "Number of local flashcards to prepare.",
      "type": "integer",
      "minimum": 1,
      "maximum": 30
    },
    "mode": {
      "default": "mixed",
      "description": "Card selection strategy.",
      "type": "string",
      "enum": [
        "mixed",
        "due",
        "new",
        "weak",
        "random"
      ]
    },
    "query": {
      "default": "",
      "description": "Optional phrase, meaning, or usage search filter.",
      "type": "string"
    },
    "setId": {
      "default": "core",
      "description": "Built-in wordbook id.",
      "type": "string",
      "enum": [
        "core",
        "listening",
        "reading"
      ]
    }
  },
  "required": [
    "excludeRecentlyReviewedDays",
    "groupId",
    "includeMastered",
    "learningState",
    "limit",
    "mode",
    "query",
    "setId"
  ],
  "additionalProperties": false
}

统一响应

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

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

错误码

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