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

# API reference

The field-level pages are generated from the declarations, so they always match what ships; each field's semantics, deprecations and parameter constraints live in its JSDoc, both here and on hover in your IDE.

Concepts — the response envelope and error handling, paging through `query` results, narrowing `query.pages` with `QueryPage`, reading log event details, how field types map to the wire format, activating extension packs — are covered in the [guide](https://types-mediawiki-response.pages.dev/guide/getting-started.md). This tree is the field-level reference.

## Core

Everything MediaWiki **core** can return: the response envelope ([ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md), [ApiResponseWith](https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md)), shared atoms ([Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), [Timestamp](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) …), one response type per `action=` ([ApiQueryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md), [ApiEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md) …), and the `action=query` framework — [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md), [ApiQueryResult](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md), the [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) projection, per-module continue tokens ([ApiQueryContinue](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md)) and the per-action structured log details of [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md).

Each single-module `action=` maps to one response type:

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

Browse the [full Core reference](https://types-mediawiki-response.pages.dev/api/core/overview.md).

## Extension packs

Extension responses are opt-in: each pack lives at the subpath `types-mediawiki-response/ext/<name>` and is activated by a single type-only import — see [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md). Packs for query sub-modules merge their fields into the shared `ApiPage` / `ApiQueryResult`; packs for extension actions export standalone response types to `import type` directly.

| Pack                                                                                                     | Extension            | Covers                                                                                 |
| -------------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------- |
| [abusefilters](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/overview.md)       | AbuseFilter          | `list=abusefilters` / `list=abuselog`, `action=abusefilter*` checks                    |
| [babel](https://types-mediawiki-response.pages.dev/api/extensions/babel/overview.md)                     | Babel                | `meta=babel`                                                                           |
| [categorytree](https://types-mediawiki-response.pages.dev/api/extensions/categorytree/overview.md)       | CategoryTree         | `action=categorytree` (standalone)                                                     |
| [description](https://types-mediawiki-response.pages.dev/api/extensions/description/overview.md)         | Wikibase Client      | `prop=description`                                                                     |
| [discussiontools](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/overview.md) | DiscussionTools      | `action=discussiontools*` (pageinfo, findcomment, subscriptions, …)                    |
| [echo](https://types-mediawiki-response.pages.dev/api/extensions/echo/overview.md)                       | Echo / Notifications | `meta=notifications` and related `meta=` / `action=echomute`, `action=echocreateevent` |
| [extracts](https://types-mediawiki-response.pages.dev/api/extensions/extracts/overview.md)               | TextExtracts         | `prop=extracts`                                                                        |
| [flaggedrevs](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/overview.md)         | FlaggedRevs          | `prop=flagged`, `list=unreviewedpages` …, `action=review` / `action=stabilize`         |
| [gadgets](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/overview.md)                 | Gadgets              | `list=gadgets`, `list=gadgetcategories`                                                |
| [globalblocks](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/overview.md)       | GlobalBlocking       | `list=globalblocks`                                                                    |
| [globalusage](https://types-mediawiki-response.pages.dev/api/extensions/globalusage/overview.md)         | GlobalUsage          | `prop=globalusage`                                                                     |
| [globaluserinfo](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/overview.md)   | CentralAuth          | `meta=globaluserinfo`                                                                  |
| [linter](https://types-mediawiki-response.pages.dev/api/extensions/linter/overview.md)                   | Linter               | `list=linterrors`, `meta=linterstats`                                                  |
| [pageimages](https://types-mediawiki-response.pages.dev/api/extensions/pageimages/overview.md)           | PageImages           | `prop=pageimages`                                                                      |
| [pageviews](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/overview.md)             | PageViewInfo         | `prop=pageviews`, `list=mostviewed`, `meta=siteviews`                                  |
| [scribunto](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/overview.md)             | Scribunto            | `action=scribunto-console` (standalone)                                                |
| [spamblacklist](https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/overview.md)     | SpamBlacklist        | `action=spamblacklist` (standalone)                                                    |
| [templatedata](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/overview.md)       | TemplateData         | `action=templatedata` (standalone)                                                     |
| [thanks](https://types-mediawiki-response.pages.dev/api/extensions/thanks/overview.md)                   | Thanks               | `action=thank` (standalone)                                                            |
| [titleblacklist](https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/overview.md)   | TitleBlacklist       | `action=titleblacklist` (standalone)                                                   |
| [visualeditor](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/overview.md)       | VisualEditor         | `action=visualeditor`, `action=visualeditoredit` … (standalone)                        |
| [wikibase](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/overview.md)               | Wikibase             | `meta=wikibase`, `prop=pageterms`, `list=wblistentityusage`                            |