公开数据
标记为 Public 的接口无需访问令牌,适合题库发现、公开资料和能力目录读取。
查看 JSON 目录Agent API · v1.0.0
面向开发者与 AI Agent 的雅思学习数据接口。接口目录、请求参数和 OpenAPI 由同一份运行时注册表生成,能力变化时文档同步更新。
const response = await fetch(
"https://ieltsbuddy.igopx.cn/api/public/developer-api/catalog.json"
);
const catalog = await response.json();
console.log(catalog.capabilities);公开内容可直接读取;个人数据需用户在网页确认账号绑定。Token 包含签发时的用户接口权限,可随时在设置中撤销。
标记为 Public 的接口无需访问令牌,适合题库发现、公开资料和能力目录读取。
查看 JSON 目录Bearer 接口先由用户确认账号绑定,再按 scope 读取练习、计划与学习记录。
查看账号授权步骤AI Agent 可优先读取每个 operation 对应的 Markdown 文档;其中包含输入结构、权限范围、验证方式和统一响应说明。
API reference
API Base URL:https://work.ieltsbuddy.igopx.cn
Submit product feedback explicitly requested by the user as their authenticated account. Saves a text message in the existing website feedback conversation and notifies the team. Never submit automatically or include credentials. Returns the saved message id and createdAt; after an uncertain response, read feedback.list before retrying to avoid duplicates.
/api/v1/agent/capabilities/ielts_feedback_create/api/v1/agent/capabilities/ielts_feedback_createielts_feedback_createRead the authenticated user's latest 200 messages, including submitted feedback and team replies, ordered oldest to newest within that window. Returns messages and unreadCount; does not mark replies as read. Each message includes id, content, createdAt, senderType, source and pagePath.
/api/v1/agent/capabilities/ielts_feedback_list/api/v1/agent/capabilities/ielts_feedback_listielts_feedback_listRead 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/api/v1/agent/capabilities/ielts_learning_route_readielts_learning_route_readSearch 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/api/v1/agent/capabilities/ielts_courses_search_sectionsielts_courses_search_sectionsSearch 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/api/v1/agent/capabilities/ielts_assets_searchielts_assets_searchFind 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/api/v1/agent/capabilities/ielts_resources_relatedielts_resources_relatedSearch 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/api/v1/agent/capabilities/ielts_vocabulary_personal_searchielts_vocabulary_personal_searchExport 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/api/v1/agent/capabilities/ielts_vocabulary_personal_exportielts_vocabulary_personal_exportRead spaced-repetition progress from the current user's personal vocabulary book.
/api/v1/agent/capabilities/ielts_vocabulary_personal_progress/api/v1/agent/capabilities/ielts_vocabulary_personal_progressielts_vocabulary_personal_progressPrepare flashcards from the current user's personal vocabulary book.
/api/v1/agent/capabilities/ielts_vocabulary_personal_prepare_cards/api/v1/agent/capabilities/ielts_vocabulary_personal_prepare_cardsielts_vocabulary_personal_prepare_cardsAdd 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/api/v1/agent/capabilities/ielts_vocabulary_personal_addielts_vocabulary_personal_addImport 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/api/v1/agent/capabilities/ielts_vocabulary_personal_importielts_vocabulary_personal_importUpdate the editable content of one personal vocabulary entry. Learning state changes only through recorded review results.
/api/v1/agent/capabilities/ielts_vocabulary_personal_update/api/v1/agent/capabilities/ielts_vocabulary_personal_updateielts_vocabulary_personal_updateRecord one review result for a personal vocabulary entry and update spaced-repetition progress.
/api/v1/agent/capabilities/ielts_vocabulary_personal_record_review/api/v1/agent/capabilities/ielts_vocabulary_personal_record_reviewielts_vocabulary_personal_record_reviewDelete one entry from the current user's personal vocabulary book.
/api/v1/agent/capabilities/ielts_vocabulary_personal_delete/api/v1/agent/capabilities/ielts_vocabulary_personal_deleteielts_vocabulary_personal_deleteRead 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/api/v1/agent/capabilities/ielts_vocabulary_builtin_progressielts_vocabulary_builtin_progressPrepare flashcards from an enabled licensed built-in IELTS vocabulary set.
/api/v1/agent/capabilities/ielts_vocabulary_builtin_prepare_cards/api/v1/agent/capabilities/ielts_vocabulary_builtin_prepare_cardsielts_vocabulary_builtin_prepare_cardsRecord one review result for an enabled licensed built-in vocabulary entry.
/api/v1/agent/capabilities/ielts_vocabulary_builtin_record_review/api/v1/agent/capabilities/ielts_vocabulary_builtin_record_reviewielts_vocabulary_builtin_record_reviewSearch 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/api/v1/agent/capabilities/ielts_prep_search_guidesielts_prep_search_guidesRead one full published IELTS Buddy knowledge article by slug.
/api/v1/agent/capabilities/ielts_prep_read_guide/api/v1/agent/capabilities/ielts_prep_read_guideielts_prep_read_guideSearch 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/api/v1/agent/capabilities/ielts_prediction_search_hitsielts_prediction_search_hitsSearch up to six compact IELTS Buddy question-bank candidates by subject, Part number, question type, configured listening audio, text, difficulty, or taxonomy. Use subject=listening and requiresAudio=true for listening practice. Each result includes audioAvailable, partId and a stable question_part contentRef. The server returns facts and the local Agent chooses the question.
/api/v1/agent/capabilities/ielts_practice_search_parts/api/v1/agent/capabilities/ielts_practice_search_partsielts_practice_search_partsMatch one learner-provided keyword set or content excerpt to up to three relevant IELTS Buddy Parts. The query stays as raw content; explicitly requested Part number and question type can constrain results. Use subject=listening and requiresAudio=true for listening practice. Results include audioAvailable, a factual match mode, stable question_part contentRef, and an attributed browser practice entry. The server does not start a session or generate answers.
/api/v1/agent/capabilities/ielts_practice_match_parts/api/v1/agent/capabilities/ielts_practice_match_partsielts_practice_match_partsSearch 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/api/v1/agent/capabilities/ielts_dictation_search_materialsielts_dictation_search_materialsList 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/api/v1/agent/capabilities/ielts_dictation_recent_attemptsielts_dictation_recent_attemptsRead 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/api/v1/agent/capabilities/ielts_dictation_read_attemptielts_dictation_read_attemptBrowse 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/api/v1/agent/capabilities/ielts_practice_list_taxonomyielts_practice_list_taxonomyRead 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/api/v1/agent/capabilities/ielts_practice_read_partielts_practice_read_partSearch 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/api/v1/agent/capabilities/ielts_speaking_materials_searchielts_speaking_materials_searchRead one exact active speaking material with its linked questions and recent practice history.
/api/v1/agent/capabilities/ielts_speaking_materials_read/api/v1/agent/capabilities/ielts_speaking_materials_readielts_speaking_materials_readCreate 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/api/v1/agent/capabilities/ielts_speaking_materials_createielts_speaking_materials_createUpdate 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/api/v1/agent/capabilities/ielts_speaking_materials_updateielts_speaking_materials_updateArchive one speaking material from the active library.
/api/v1/agent/capabilities/ielts_speaking_materials_archive/api/v1/agent/capabilities/ielts_speaking_materials_archiveielts_speaking_materials_archiveRead 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/api/v1/agent/capabilities/ielts_practice_read_sessionielts_practice_read_sessionList 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/api/v1/agent/capabilities/ielts_review_recent_activityielts_review_recent_activityRead a paginated immutable review snapshot for one exact standalone practice record or one completed mock section, including recorded response modality, grading facts, available evidence anchors, and optional bounded source material for local Agent analysis.
/api/v1/agent/capabilities/ielts_review_read_snapshot/api/v1/agent/capabilities/ielts_review_read_snapshotielts_review_read_snapshotList 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/api/v1/agent/capabilities/ielts_practice_recent_activityielts_practice_recent_activitySearch 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/api/v1/agent/capabilities/ielts_mock_search_papersielts_mock_search_papersCreate 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/api/v1/agent/capabilities/ielts_mock_create_paperielts_mock_create_paperRead 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/api/v1/agent/capabilities/ielts_writing_read_practiceielts_writing_read_practiceList the authenticated user's learning timeline with complete filtered-history totals and Asia/Shanghai daily statistics, independent of page size. Continue with nextCursor. Video progress is one activity per section/day; learning.events.pull reads raw evidence.
/api/v1/agent/capabilities/ielts_footprints_list/api/v1/agent/capabilities/ielts_footprints_listielts_footprints_listRead 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/api/v1/agent/capabilities/ielts_learner_read_profileielts_learner_read_profileDownload one consistent, versioned, read-only JSON snapshot of the current user's learning records for local Agent analysis. No database software or Skill installation required. Prefer this for cross-module personal learning analysis; existing individual APIs remain available.
/api/v1/agent/capabilities/ielts_learner_export_data/api/v1/agent/capabilities/ielts_learner_export_dataielts_learner_export_dataPull 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/api/v1/agent/capabilities/ielts_learning_pull_eventsielts_learning_pull_eventsIdempotently 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/api/v1/agent/capabilities/ielts_learning_push_eventsielts_learning_push_eventsList 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/api/v1/agent/capabilities/ielts_study_plans_listielts_study_plans_listList the shared human-and-AI todo list, including each item's optional scheduledAt and WeChat setting.
/api/v1/agent/capabilities/ielts_study_todos_list/api/v1/agent/capabilities/ielts_study_todos_listielts_study_todos_listImmediately add one or more todos. Title is required; future whole-hour scheduledAt with timezone and exact site contentRef are optional. In-page and authorized browser notifications fire at scheduledAt; WeChat is off by default. No draft confirmation step.
/api/v1/agent/capabilities/ielts_study_todos_create/api/v1/agent/capabilities/ielts_study_todos_createielts_study_todos_createEdit the title, note, optional whole-hour scheduledAt, WeChat reminder setting, optional site contentRef, or completion status of an exact todo id.
/api/v1/agent/capabilities/ielts_study_todos_update/api/v1/agent/capabilities/ielts_study_todos_updateielts_study_todos_updateDelete an exact todo from the shared list.
/api/v1/agent/capabilities/ielts_study_todos_delete/api/v1/agent/capabilities/ielts_study_todos_deleteielts_study_todos_deleteRead 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/api/v1/agent/capabilities/ielts_study_plans_getielts_study_plans_getCreate 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/api/v1/agent/capabilities/ielts_study_plans_createielts_study_plans_createRead whether WeChat can actually deliver reminders, including connection and message context. Returns the missing user action without exposing credentials.
/api/v1/agent/capabilities/ielts_reminders_get_delivery_status/api/v1/agent/capabilities/ielts_reminders_get_delivery_statusielts_reminders_get_delivery_statusPresent a WeChat connection card in the current conversation. The user connects in this card, then the conversation can continue. Does not bind an account by itself.
/api/v1/agent/capabilities/ielts_reminders_connect_wechat/api/v1/agent/capabilities/ielts_reminders_connect_wechatielts_reminders_connect_wechatCreate a one-time reminder with content and an exact future remindAt timestamp including timezone. In-page and browser reminders are automatic; wechatEnabled defaults true and never blocks creation when WeChat is disconnected. No plan or task is required.
/api/v1/agent/capabilities/ielts_reminders_create/api/v1/agent/capabilities/ielts_reminders_createielts_reminders_createEnable or disable WeChat Bot delivery for one exact future reminder. In-page and browser reminders remain enabled.
/api/v1/agent/capabilities/ielts_reminders_update/api/v1/agent/capabilities/ielts_reminders_updateielts_reminders_updateRead this user's reminders, including content, exact time and delivery status. Use offset for pagination.
/api/v1/agent/capabilities/ielts_reminders_list/api/v1/agent/capabilities/ielts_reminders_listielts_reminders_listCancel an exact reminder returned by reminders.list. Does not change any study plan. Running or finished reminders cannot be cancelled.
/api/v1/agent/capabilities/ielts_reminders_cancel/api/v1/agent/capabilities/ielts_reminders_cancelielts_reminders_cancelRead whether WeChat iLink is connected and can receive task notifications. This operation changes no notification settings.
/api/v1/agent/capabilities/ielts_notifications_get_status/api/v1/agent/capabilities/ielts_notifications_get_statusielts_notifications_get_statusEnable or disable WeChat iLink delivery for exact existing task ids. It does not require an active connection and never changes a plan or task schedule.
/api/v1/agent/capabilities/ielts_notifications_configure_wechat_task_reminders/api/v1/agent/capabilities/ielts_notifications_configure_wechat_task_remindersielts_notifications_configure_wechat_task_remindersUpdate 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/api/v1/agent/capabilities/ielts_study_plans_updateielts_study_plans_updateAtomically 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/api/v1/agent/capabilities/ielts_study_plans_change_tasksielts_study_plans_change_tasksReplace 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/api/v1/agent/capabilities/ielts_study_plans_replanielts_study_plans_replanDelete a study plan and all tasks that belong to it.
/api/v1/agent/capabilities/ielts_study_plans_delete/api/v1/agent/capabilities/ielts_study_plans_deleteielts_study_plans_delete