Agent API · v1.0.0

IELTS Buddy API

面向开发者与 AI Agent 的雅思学习数据接口。接口目录、请求参数和 OpenAPI 由同一份运行时注册表生成,能力变化时文档同步更新。

从机器可读目录开始

先读取接口清单,再按 operation 获取 JSON、Markdown 或人类可读文档。

JavaScriptcatalog.json
const response = await fetch(
  "https://ieltsbuddy.igopx.cn/api/public/developer-api/catalog.json"
);

const catalog = await response.json();

console.log(catalog.capabilities);
50接口
13数据域
3免认证

选择接入方式

公开内容可直接读取;涉及个人学习记录时,由用户完成绑定并授权对应 scope。

公开数据

标记为 Public 的接口无需访问令牌,适合题库发现、公开资料和能力目录读取。

查看 JSON 目录

个人数据

Bearer 接口先由用户确认账号绑定,再按 scope 读取练习、计划与学习记录。

查看鉴权定义

AI Agent 可优先读取每个 operation 对应的 Markdown 文档;其中包含输入结构、权限范围、验证方式和统一响应说明。

API reference

接口目录

API Base URL:https://work.ieltsbuddy.igopx.cn

POST

Read learning route

Read the IELTS full-course learning route as factual data, grouped by subject and unit, with course-level progress. Use view=progress for a compact summary. The Tool does not choose or recommend the next course.

/api/v1/agent/capabilities/ielts_learning_route_read
Bearer
POST

Search course sections

Search published course video sections by subject, literal keyword, or literal course tag query. The server returns factual section candidates and a stable contentRef; the local Agent decides whether one fits the learner.

/api/v1/agent/capabilities/ielts_courses_search_sections
Bearer
POST

Search user assets

Search the current user's active file and document assets by title or indexed content. Results are compact and paginated, and include a stable asset contentRef. This is the asset module's only catalog-search interface.

/api/v1/agent/capabilities/ielts_assets_search
Bearer
POST

Find related learning resources

Find explicitly or structurally related resources from a stable contentRef, such as course-to-practice and prediction-to-question relationships. Resource discovery and full reads remain owned by each resource Domain.

/api/v1/agent/capabilities/ielts_resources_related
Bearer
POST

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.

/api/v1/agent/capabilities/ielts_vocabulary_personal_search
Bearer
POST

Export personal vocabulary

Export personal vocabulary content as JSON or CSV for a local Agent or user-owned backup. Review progress is intentionally excluded.

/api/v1/agent/capabilities/ielts_vocabulary_personal_export
Bearer
POST

Read personal vocabulary progress

Read spaced-repetition progress from the current user's personal vocabulary book.

/api/v1/agent/capabilities/ielts_vocabulary_personal_progress
Bearer
POST

Prepare personal vocabulary cards

Prepare flashcards from the current user's personal vocabulary book.

/api/v1/agent/capabilities/ielts_vocabulary_personal_prepare_cards
Bearer
POST

Add personal vocabulary

Write

Add or enrich up to 100 words directly in the current user's personal vocabulary book while recording their source.

/api/v1/agent/capabilities/ielts_vocabulary_personal_add
Bearer
POST

Import personal vocabulary

Write

Import up to 500 personal vocabulary entries from JSON or CSV. Imported entries start with fresh learning progress and keep an import source record.

/api/v1/agent/capabilities/ielts_vocabulary_personal_import
Bearer
POST

Update personal vocabulary

Write

Update the editable content of one personal vocabulary entry. Learning state changes only through recorded review results.

/api/v1/agent/capabilities/ielts_vocabulary_personal_update
Bearer
POST

Record personal vocabulary review

Write

Record one review result for a personal vocabulary entry and update spaced-repetition progress.

/api/v1/agent/capabilities/ielts_vocabulary_personal_record_review
Bearer
POST

Delete personal vocabulary

Write

Delete one entry from the current user's personal vocabulary book.

/api/v1/agent/capabilities/ielts_vocabulary_personal_delete
Bearer
POST

Read built-in vocabulary progress

Read compact progress statistics for an enabled built-in IELTS vocabulary set, or per-word progress for up to 50 exact entry ids.

/api/v1/agent/capabilities/ielts_vocabulary_builtin_progress
Bearer
POST

Prepare built-in vocabulary cards

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

/api/v1/agent/capabilities/ielts_vocabulary_builtin_prepare_cards
Bearer
POST

Record built-in vocabulary review

Write

Record one review result for an enabled licensed built-in vocabulary entry.

/api/v1/agent/capabilities/ielts_vocabulary_builtin_record_review
Bearer
POST

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.

/api/v1/agent/capabilities/ielts_prep_search_guides
Public
POST

Read IELTS knowledge article

Read one full published IELTS Buddy knowledge article by slug.

/api/v1/agent/capabilities/ielts_prep_read_guide
Public
POST

Search prediction records and candidates

Search sourced IELTS prediction records and their possible matching questions by record kind, source, exact id, date, month, subject, or keyword. Results preserve source attribution, distinguish dated exam reports from rolling rankings, and include practice targets only for candidates already in the question bank.

/api/v1/agent/capabilities/ielts_prediction_search_hits
Public
POST

Search practice parts

Search up to six compact IELTS Buddy question-bank candidates by subject, text, difficulty, exact tag ids, or literal tagQueries. Each result includes partId and a stable question_part contentRef. Source claims come only from origin fields; the server returns facts and the local Agent chooses the question.

/api/v1/agent/capabilities/ielts_practice_search_parts
Bearer
POST

Search dictation materials

Search exact listening materials ready for sentence-level dictation by title, difficulty, and literal taxonomy terms. Results are paginated and include factual tags, segment count, and a stable listening_dictation contentRef. The local Agent chooses the material.

/api/v1/agent/capabilities/ielts_dictation_search_materials
Bearer
POST

Read recent dictation attempts

List the authenticated user's submitted listening-dictation attempts in reverse chronological order. Results contain factual scores, missed-word counts, exact attempt ids, and optional Part entry links; this operation does not diagnose mistakes.

/api/v1/agent/capabilities/ielts_dictation_recent_attempts
Bearer
POST

Read dictation attempt

Read one exact submitted listening-dictation attempt owned by the authenticated user, including paginated sentence snapshots, user entries, expected words, match results, translations, and score facts for local Agent review.

/api/v1/agent/capabilities/ielts_dictation_read_attempt
Bearer
POST

List practice taxonomy

Browse active IELTS question taxonomy, resolve ambiguous filter terms, and return availability counts. practice.search_parts accepts literal tagQueries directly, so use this Tool only when taxonomy discovery, disambiguation, or counts are needed.

/api/v1/agent/capabilities/ielts_practice_list_taxonomy
Bearer
POST

Read question Part

Read one active question Part without answers, explanations, or listening transcript. The result includes the same stable contentRef used by other consumers.

/api/v1/agent/capabilities/ielts_practice_read_part
Bearer
POST

Search speaking materials

Search the user's active speaking materials by title, story, or tag. Results are compact and paginated, and include a stable speaking_material contentRef. This is the speaking-material module's only search interface.

/api/v1/agent/capabilities/ielts_speaking_materials_search
Bearer
POST

Read speaking material

Read one exact active speaking material with its linked questions and recent practice history.

/api/v1/agent/capabilities/ielts_speaking_materials_read
Bearer
POST

Create speaking material

Write

Create one speaking material. Exact question links are optional and are only written when explicitly provided; omitted links remain empty.

/api/v1/agent/capabilities/ielts_speaking_materials_create
Bearer
POST

Update speaking material

Write

Update one speaking material. Question links change only when exact links are explicitly provided; story edits do not trigger hidden matching.

/api/v1/agent/capabilities/ielts_speaking_materials_update
Bearer
POST

Archive speaking material

Write

Archive one speaking material from the active library.

/api/v1/agent/capabilities/ielts_speaking_materials_archive
Bearer
POST

Read practice session

Read one owned standalone practice record by its sessionId. Mock sessions are rejected. It returns the exact record state, scoring summary, timestamps, and browser route, but not question-level answers or review evidence.

/api/v1/agent/capabilities/ielts_practice_read_session
Bearer
POST

Read reviewable activity

List factual standalone-practice and mock records that can be selected for review. Mock records include section-level completion and grading facts; every result exposes an exact review target.

/api/v1/agent/capabilities/ielts_review_recent_activity
Bearer
POST

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.

/api/v1/agent/capabilities/ielts_review_read_snapshot
Bearer
POST

Read recent practice activity

List the current user's factual standalone practice records. It supports an Asia/Shanghai date range, subject, status, and pagination and never returns mock sessions. Every result exposes sessionId; use the independent review Domain for question-level evidence. This tool does not recommend or diagnose.

/api/v1/agent/capabilities/ielts_practice_recent_activity
Bearer
POST

Search mock papers

Search available preset and reusable user mock papers by keyword, category, required subjects, and maximum duration. Each result includes factual paper details and a stable mock_paper contentRef; the local Agent chooses the paper.

/api/v1/agent/capabilities/ielts_mock_search_papers
Bearer
POST

Create reusable mock paper

Write

Create one reusable user mock paper from exact published Part ids returned by practice.search_parts. The selected Parts must form complete IELTS sections. Returns a stable mock_paper contentRef for catalog entry or study-plan tasks.

/api/v1/agent/capabilities/ielts_mock_create_paper
Bearer
POST

Read writing practice

Read immutable versions and structured teacher reviews for a saved writing practice. Use the returned practice id and version fields as the only source for writing-practice facts.

/api/v1/agent/capabilities/ielts_writing_read_practice
Bearer
POST

List learning footprints

List the authenticated user's unified learning footprint with activity, time-range, search, and pagination filters.

/api/v1/agent/capabilities/ielts_footprints_list
Bearer
POST

Read learner profile

Read the current user's normalized IELTS skill profile and lightweight 30-day evidence summary. For a chronological activity list, use footprints.list; for concrete practice records, use practice.recent_activity.

/api/v1/agent/capabilities/ielts_learner_read_profile
Bearer
POST

Pull learning events

Pull the authenticated user's authoritative append-only learning events after a cursor for a local mirror or web Agent context.

/api/v1/agent/capabilities/ielts_learning_pull_events
Bearer
POST

Push learning events

Write

Idempotently append a batch of explicitly typed Agent-owned learning evidence events. Server-owned practice, mock, course, and browser event namespaces are rejected.

/api/v1/agent/capabilities/ielts_learning_push_events
Bearer
POST

List study plans

List the user's study plans with exact ids, revisions, progress, and latest review so an existing plan can be selected.

/api/v1/agent/capabilities/ielts_study_plans_list
Bearer
POST

Read study plan

Read one study plan by an exact id returned by the conversation, workspace context, or plan list. Tasks are returned in chronological pages with an opaque nextCursor.

/api/v1/agent/capabilities/ielts_study_plans_get
Bearer
POST

Create study plan

Write

Create a plan from explicit learning tasks. Each task binds one exact selected contentRef, a calendar date, and one of morning, afternoon, or evening; the Tool resolves current content facts and stores the execution snapshot.

/api/v1/agent/capabilities/ielts_study_plans_create
Bearer
POST

Read notification status

Read whether WeChat iLink is connected and whether the user has globally enabled WeChat task notifications. This operation changes no notification settings.

/api/v1/agent/capabilities/ielts_notifications_get_status
Bearer
POST

Configure WeChat task reminders

Write

Enable or disable WeChat iLink delivery for exact existing task ids. It requires a connected iLink and globally enabled WeChat notifications, and never changes a plan or task schedule.

/api/v1/agent/capabilities/ielts_notifications_configure_wechat_task_reminders
Bearer
POST

Update study plan

Write

Update only a study plan's title or goal. It does not add, remove, reschedule, or complete tasks.

/api/v1/agent/capabilities/ielts_study_plans_update
Bearer
POST

Change study plan tasks

Write

Atomically add, edit, remove, or complete exact tasks in one plan. An edit may change an unstarted task's date, morning/afternoon/evening slot, duration, or selected contentRef; after a task starts, its resolved target remains fixed so completion cannot be attributed to different content. It does not change the plan title or goal.

/api/v1/agent/capabilities/ielts_study_plans_change_tasks
Bearer
POST

Replan study plan

Write

Replace the unfinished learning tasks of one plan in one transaction. The plan keeps its identity and completed work; each new task uses an exact selected contentRef and a morning, afternoon, or evening slot.

/api/v1/agent/capabilities/ielts_study_plans_replan
Bearer
POST

Delete study plan

Write

Delete a study plan and all tasks that belong to it.

/api/v1/agent/capabilities/ielts_study_plans_delete
Bearer