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, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/api/index.md.
types-mediawiki-response
  • English

      • 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. This tree is the field-level reference.

      Core

      Everything MediaWiki core can return: the response envelope (ApiEnvelope, ApiResponseWith), shared atoms (Flag, Timestamp …), one response type per action= (ApiQueryResponse, ApiEditResponse …), and the action=query framework — ApiPage, ApiQueryResult, the QueryPage projection, per-module continue tokens (ApiQueryContinue) and the per-action structured log details of ApiLogEventParams.

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

      action=Response type
      action=acquiretempusernameApiAcquireTempUserNameResponse
      action=blockApiBlockResponse
      action=changeauthenticationdataApiChangeAuthenticationDataResponse
      action=changecontentmodelApiChangeContentModelResponse
      action=checktokenApiCheckTokenResponse
      action=clearhasmsgApiClearHasMsgResponse
      action=clientloginApiClientLoginResponse
      action=compareApiCompareResponse
      action=createaccountApiCreateAccountResponse
      action=deleteApiDeleteResponse
      action=editApiEditResponse
      action=emailuserApiEmailUserResponse
      action=expandtemplatesApiExpandTemplatesResponse
      action=filerevertApiFileRevertResponse
      action=imagerotateApiImageRotateResponse
      action=importApiImportResponse
      action=languagesearchApiLanguageSearchResponse
      action=loginApiLoginResponse
      action=logoutApiLogoutResponse
      action=managetagsApiManageTagsResponse
      action=mergehistoryApiMergeHistoryResponse
      action=moveApiMoveResponse
      action=optionsApiOptionsResponse
      action=parseApiParseResponse
      action=patrolApiPatrolResponse
      action=protectApiProtectResponse
      action=purgeApiPurgeResponse
      action=queryApiQueryResponse
      action=removeauthenticationdataApiRemoveAuthenticationDataResponse
      action=resetpasswordApiResetPasswordResponse
      action=revisiondeleteApiRevisionDeleteResponse
      action=rollbackApiRollbackResponse
      action=setnotificationtimestampApiSetNotificationTimestampResponse
      action=setpagelanguageApiSetPageLanguageResponse
      action=stasheditApiStashEditResponse
      action=tagApiTagResponse
      action=unblockApiUnblockResponse
      action=undeleteApiUndeleteResponse
      action=uploadApiUploadResponse
      action=userrightsApiUserrightsResponse
      action=validatepasswordApiValidatePasswordResponse
      action=watchApiWatchResponse

      Browse the full Core reference.

      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. 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.

      PackExtensionCovers
      abusefiltersAbuseFilterlist=abusefilters / list=abuselog, action=abusefilter* checks
      babelBabelmeta=babel
      categorytreeCategoryTreeaction=categorytree (standalone)
      descriptionWikibase Clientprop=description
      discussiontoolsDiscussionToolsaction=discussiontools* (pageinfo, findcomment, subscriptions, …)
      echoEcho / Notificationsmeta=notifications and related meta= / action=echomute, action=echocreateevent
      extractsTextExtractsprop=extracts
      flaggedrevsFlaggedRevsprop=flagged, list=unreviewedpages …, action=review / action=stabilize
      gadgetsGadgetslist=gadgets, list=gadgetcategories
      globalblocksGlobalBlockinglist=globalblocks
      globalusageGlobalUsageprop=globalusage
      globaluserinfoCentralAuthmeta=globaluserinfo
      linterLinterlist=linterrors, meta=linterstats
      pageimagesPageImagesprop=pageimages
      pageviewsPageViewInfoprop=pageviews, list=mostviewed, meta=siteviews
      scribuntoScribuntoaction=scribunto-console (standalone)
      spamblacklistSpamBlacklistaction=spamblacklist (standalone)
      templatedataTemplateDataaction=templatedata (standalone)
      thanksThanksaction=thank (standalone)
      titleblacklistTitleBlacklistaction=titleblacklist (standalone)
      visualeditorVisualEditoraction=visualeditor, action=visualeditoredit … (standalone)
      wikibaseWikibasemeta=wikibase, prop=pageterms, list=wblistentityusage