> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt.

# API 参考

字段级页面由类型声明生成，与发布内容始终一致；每个字段的语义、弃用情况与参数约束都在 JSDoc 里，此处可查，IDE 悬停同样可见。

响应信封与错误处理、query 结果翻页、用 `QueryPage` 收窄 `query.pages`、读日志明细、字段类型与线格式的对应关系、激活扩展包这些概念见[指南](https://types-mediawiki-response.pages.dev/zh/guide/getting-started.md)；本树是字段级参考。

:::info
API 参考由 [typedoc](https://typedoc.org/) 从类型声明自动生成，暂无中文翻译。
:::

## Core

MediaWiki **核心**能返回的一切：响应信封（[ApiEnvelope](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md)、[ApiResponseWith](https://types-mediawiki-response.pages.dev/zh/api/core/ApiResponseWith.md)）、共享原子类型（[Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md)、[Timestamp](https://types-mediawiki-response.pages.dev/zh/api/core/Timestamp.md) 等）、每个 `action=` 一个响应类型（[ApiQueryResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiQueryResponse.md)、[ApiEditResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEditResponse.md) 等），以及 `action=query` 框架——[ApiPage](https://types-mediawiki-response.pages.dev/zh/api/core/ApiPage.md)、[ApiQueryResult](https://types-mediawiki-response.pages.dev/zh/api/core/ApiQueryResult.md)、[QueryPage](https://types-mediawiki-response.pages.dev/zh/api/core/QueryPage.md) 投影、各模块的续传令牌（[ApiQueryContinue](https://types-mediawiki-response.pages.dev/zh/api/core/ApiQueryContinue.md)），以及按 log action 建模的日志明细 [ApiLogEventParams](https://types-mediawiki-response.pages.dev/zh/api/core/ApiLogEventParams.md)。

单模块 `action=` 各对应一个响应类型：

| `action=`                         | 响应类型                                                                                                                                 |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `action=acquiretempusername`      | [ApiAcquireTempUserNameResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiAcquireTempUserNameResponse.md)           |
| `action=block`                    | [ApiBlockResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiBlockResponse.md)                                       |
| `action=changeauthenticationdata` | [ApiChangeAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiChangeAuthenticationDataResponse.md) |
| `action=changecontentmodel`       | [ApiChangeContentModelResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiChangeContentModelResponse.md)             |
| `action=checktoken`               | [ApiCheckTokenResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiCheckTokenResponse.md)                             |
| `action=clearhasmsg`              | [ApiClearHasMsgResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiClearHasMsgResponse.md)                           |
| `action=clientlogin`              | [ApiClientLoginResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiClientLoginResponse.md)                           |
| `action=compare`                  | [ApiCompareResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiCompareResponse.md)                                   |
| `action=createaccount`            | [ApiCreateAccountResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiCreateAccountResponse.md)                       |
| `action=delete`                   | [ApiDeleteResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiDeleteResponse.md)                                     |
| `action=edit`                     | [ApiEditResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEditResponse.md)                                         |
| `action=emailuser`                | [ApiEmailUserResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEmailUserResponse.md)                               |
| `action=expandtemplates`          | [ApiExpandTemplatesResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiExpandTemplatesResponse.md)                   |
| `action=filerevert`               | [ApiFileRevertResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiFileRevertResponse.md)                             |
| `action=imagerotate`              | [ApiImageRotateResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiImageRotateResponse.md)                           |
| `action=import`                   | [ApiImportResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiImportResponse.md)                                     |
| `action=languagesearch`           | [ApiLanguageSearchResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiLanguageSearchResponse.md)                     |
| `action=login`                    | [ApiLoginResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiLoginResponse.md)                                       |
| `action=logout`                   | [ApiLogoutResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiLogoutResponse.md)                                     |
| `action=managetags`               | [ApiManageTagsResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiManageTagsResponse.md)                             |
| `action=mergehistory`             | [ApiMergeHistoryResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiMergeHistoryResponse.md)                         |
| `action=move`                     | [ApiMoveResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiMoveResponse.md)                                         |
| `action=options`                  | [ApiOptionsResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiOptionsResponse.md)                                   |
| `action=parse`                    | [ApiParseResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiParseResponse.md)                                       |
| `action=patrol`                   | [ApiPatrolResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiPatrolResponse.md)                                     |
| `action=protect`                  | [ApiProtectResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiProtectResponse.md)                                   |
| `action=purge`                    | [ApiPurgeResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiPurgeResponse.md)                                       |
| `action=query`                    | [ApiQueryResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiQueryResponse.md)                                       |
| `action=removeauthenticationdata` | [ApiRemoveAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiRemoveAuthenticationDataResponse.md) |
| `action=resetpassword`            | [ApiResetPasswordResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiResetPasswordResponse.md)                       |
| `action=revisiondelete`           | [ApiRevisionDeleteResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiRevisionDeleteResponse.md)                     |
| `action=rollback`                 | [ApiRollbackResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiRollbackResponse.md)                                 |
| `action=setnotificationtimestamp` | [ApiSetNotificationTimestampResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiSetNotificationTimestampResponse.md) |
| `action=setpagelanguage`          | [ApiSetPageLanguageResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiSetPageLanguageResponse.md)                   |
| `action=stashedit`                | [ApiStashEditResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiStashEditResponse.md)                               |
| `action=tag`                      | [ApiTagResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiTagResponse.md)                                           |
| `action=unblock`                  | [ApiUnblockResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUnblockResponse.md)                                   |
| `action=undelete`                 | [ApiUndeleteResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUndeleteResponse.md)                                 |
| `action=upload`                   | [ApiUploadResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUploadResponse.md)                                     |
| `action=userrights`               | [ApiUserrightsResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserrightsResponse.md)                             |
| `action=validatepassword`         | [ApiValidatePasswordResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiValidatePasswordResponse.md)                 |
| `action=watch`                    | [ApiWatchResponse](https://types-mediawiki-response.pages.dev/zh/api/core/ApiWatchResponse.md)                                       |

完整 Core 参考见 [Core 总览](https://types-mediawiki-response.pages.dev/zh/api/core/overview.md)。

## 扩展包

扩展响应按需启用：每个包位于子路径 `types-mediawiki-response/ext/<name>`，一条 type-only import 即可激活——见[按需启用扩展包](https://types-mediawiki-response.pages.dev/zh/guide/ext-packs.md)。query 子模块的包把字段并入共享的 `ApiPage` / `ApiQueryResult`；扩展 action 的包导出独立响应类型，`import type` 直接使用。

| 包                                                                                                           | 扩展                   | 覆盖                                                                           |
| ----------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------------- |
| [abusefilters](https://types-mediawiki-response.pages.dev/zh/api/extensions/abusefilters/overview.md)       | AbuseFilter          | `list=abusefilters` / `list=abuselog`，`action=abusefilter*` 系列检查             |
| [babel](https://types-mediawiki-response.pages.dev/zh/api/extensions/babel/overview.md)                     | Babel                | `meta=babel`                                                                 |
| [categorytree](https://types-mediawiki-response.pages.dev/zh/api/extensions/categorytree/overview.md)       | CategoryTree         | `action=categorytree`（独立类型）                                                  |
| [description](https://types-mediawiki-response.pages.dev/zh/api/extensions/description/overview.md)         | Wikibase Client      | `prop=description`                                                           |
| [discussiontools](https://types-mediawiki-response.pages.dev/zh/api/extensions/discussiontools/overview.md) | DiscussionTools      | `action=discussiontools*`（pageinfo、findcomment、subscriptions 等）              |
| [echo](https://types-mediawiki-response.pages.dev/zh/api/extensions/echo/overview.md)                       | Echo / Notifications | `meta=notifications` 及相关 `meta=`、`action=echomute`、`action=echocreateevent`  |
| [extracts](https://types-mediawiki-response.pages.dev/zh/api/extensions/extracts/overview.md)               | TextExtracts         | `prop=extracts`                                                              |
| [flaggedrevs](https://types-mediawiki-response.pages.dev/zh/api/extensions/flaggedrevs/overview.md)         | FlaggedRevs          | `prop=flagged`、`list=unreviewedpages` 等、`action=review` / `action=stabilize` |
| [gadgets](https://types-mediawiki-response.pages.dev/zh/api/extensions/gadgets/overview.md)                 | Gadgets              | `list=gadgets`、`list=gadgetcategories`                                       |
| [globalblocks](https://types-mediawiki-response.pages.dev/zh/api/extensions/globalblocks/overview.md)       | GlobalBlocking       | `list=globalblocks`                                                          |
| [globalusage](https://types-mediawiki-response.pages.dev/zh/api/extensions/globalusage/overview.md)         | GlobalUsage          | `prop=globalusage`                                                           |
| [globaluserinfo](https://types-mediawiki-response.pages.dev/zh/api/extensions/globaluserinfo/overview.md)   | CentralAuth          | `meta=globaluserinfo`                                                        |
| [linter](https://types-mediawiki-response.pages.dev/zh/api/extensions/linter/overview.md)                   | Linter               | `list=linterrors`、`meta=linterstats`                                         |
| [pageimages](https://types-mediawiki-response.pages.dev/zh/api/extensions/pageimages/overview.md)           | PageImages           | `prop=pageimages`                                                            |
| [pageviews](https://types-mediawiki-response.pages.dev/zh/api/extensions/pageviews/overview.md)             | PageViewInfo         | `prop=pageviews`、`list=mostviewed`、`meta=siteviews`                          |
| [scribunto](https://types-mediawiki-response.pages.dev/zh/api/extensions/scribunto/overview.md)             | Scribunto            | `action=scribunto-console`（独立类型）                                             |
| [spamblacklist](https://types-mediawiki-response.pages.dev/zh/api/extensions/spamblacklist/overview.md)     | SpamBlacklist        | `action=spamblacklist`（独立类型）                                                 |
| [templatedata](https://types-mediawiki-response.pages.dev/zh/api/extensions/templatedata/overview.md)       | TemplateData         | `action=templatedata`（独立类型）                                                  |
| [thanks](https://types-mediawiki-response.pages.dev/zh/api/extensions/thanks/overview.md)                   | Thanks               | `action=thank`（独立类型）                                                         |
| [titleblacklist](https://types-mediawiki-response.pages.dev/zh/api/extensions/titleblacklist/overview.md)   | TitleBlacklist       | `action=titleblacklist`（独立类型）                                                |
| [visualeditor](https://types-mediawiki-response.pages.dev/zh/api/extensions/visualeditor/overview.md)       | VisualEditor         | `action=visualeditor`、`action=visualeditoredit` 等（独立类型）                      |
| [wikibase](https://types-mediawiki-response.pages.dev/zh/api/extensions/wikibase/overview.md)               | Wikibase             | `meta=wikibase`、`prop=pageterms`、`list=wblistentityusage`                    |