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

# Interface: ApiEnvelope

Defined in: [envelope/index.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L171)

Fields that may appear on every API response, successful or not.

## Extended by

- [`ApiAbuseFilterCheckSyntaxResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckSyntaxResponse.md)
- [`ApiAbuseFilterEvalExpressionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterEvalExpressionResponse.md)
- [`ApiAbuseFilterCheckMatchResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckMatchResponse.md)
- [`ApiAbuseFilterUnblockAutopromoteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterUnblockAutopromoteResponse.md)
- [`ApiAbuseLogPrivateDetailsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogPrivateDetailsResponse.md)
- [`ApiCategoryTreeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/categorytree/ApiCategoryTreeResponse.md)
- [`ApiGlobalUserRightsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResponse.md)
- [`ApiSetGlobalAccountStatusResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResponse.md)
- [`ApiSetGlobalAccountStatusFailedResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md)
- [`ApiDeleteGlobalAccountResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResponse.md)
- [`ApiCreateLocalAccountResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResponse.md)
- [`ApiCentralAuthTokenResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthTokenResponse.md)
- [`ApiCentralAuthInBandErrorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthInBandErrorResponse.md)
- [`ApiDiscussionToolsPageInfoResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPageInfoResponse.md)
- [`ApiDiscussionToolsFindCommentResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFindCommentResponse.md)
- [`ApiDiscussionToolsGetSubscriptionsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsGetSubscriptionsResponse.md)
- [`ApiDiscussionToolsSubscribeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsSubscribeResponse.md)
- [`ApiDiscussionToolsThankResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsThankResponse.md)
- [`ApiDiscussionToolsCompareResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCompareResponse.md)
- [`ApiDiscussionToolsPreviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPreviewResponse.md)
- [`ApiDiscussionToolsEditResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsEditResponse.md)
- [`ApiEchoMuteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoMuteResponse.md)
- [`ApiEchoCreateEventResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoCreateEventResponse.md)
- [`ApiEchoPushSubscriptionsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoPushSubscriptionsResponse.md)
- [`ApiReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiReviewResponse.md)
- [`ApiStabilizeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiStabilizeResponse.md)
- [`ApiFlagConfigResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigResponse.md)
- [`ApiGlobalBlockErrorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockErrorResponse.md)
- [`ApiGlobalBlockResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResponse.md)
- [`ApiGlobalPreferencesResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md)
- [`ApiGlobalPreferenceOverridesResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverridesResponse.md)
- [`ApiEditMassMessageListResponse`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResponse.md)
- [`ApiMassMessageResponse`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResponse.md)
- [`ApiOATHValidateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidateResponse.md)
- [`ApiWebAuthnResponse`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResponse.md)
- [`ApiReadingListsSetupResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsSetupResponse.md)
- [`ApiReadingListsCreateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateResponse.md)
- [`ApiReadingListsUpdateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsUpdateResponse.md)
- [`ApiReadingListsDeleteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteResponse.md)
- [`ApiReadingListsCreateEntryResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateEntryResponse.md)
- [`ApiReadingListsDeleteEntryResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteEntryResponse.md)
- [`ApiReadingListsTeardownResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsTeardownResponse.md)
- [`ApiSiteMatrixResponse`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResponse.md)
- [`ApiSpamBlacklistResponse`](https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/ApiSpamBlacklistResponse.md)
- [`ApiTemplateDataResponse`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataResponse.md)
- [`ApiThankResponse`](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResponse.md)
- [`ApiTranscodeResetResponse`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeResetResponse.md)
- [`ApiTitleBlacklistResponse`](https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/ApiTitleBlacklistResponse.md)
- [`ApiTranslationAidsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsResponse.md)
- [`ApiTranslationStatsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStatsResponse.md)
- [`ApiTtmServerResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerResponse.md)
- [`ApiMarkForTranslationResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResponse.md)
- [`ApiTranslationReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationReviewResponse.md)
- [`ApiGroupReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiGroupReviewResponse.md)
- [`ApiAggregateGroupsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResponse.md)
- [`ApiTranslationEntitySearchResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResponse.md)
- [`ApiTranslateSandboxCreateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxCreateResponse.md)
- [`ApiTranslateSandboxActionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxActionResponse.md)
- [`ApiTranslationStashResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStashResponse.md)
- [`ApiMessageGroupSubscriptionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupSubscriptionResponse.md)
- [`ApiSearchTranslationsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsResponse.md)
- [`ApiUlsSetLanguageResponse`](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsSetLanguageResponse.md)
- [`ApiShortenUrlResponse`](https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResponse.md)
- [`ApiVisualEditorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorResponse.md)
- [`ApiVisualEditorTemplatesUsedResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md)
- [`ApiVisualEditorParseFragmentResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md)
- [`ApiVisualEditorEditResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorEditResponse.md)
- [`ApiEditCheckReferenceUrlResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiEditCheckReferenceUrlResponse.md)
- [`ApiWikiLoveResponse`](https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveResponse.md)
- [`ApiBcErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md)
- [`ApiModernErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md)
- [`ApiQueryResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md)
- [`ApiWatchlistRawResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawResponse.md)
- [`ApiParseResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiParseResponse.md)
- [`ApiParseOnlyPstResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md)
- [`ApiCompareResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResponse.md)
- [`ApiEditResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md)
- [`ApiMoveResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResponse.md)
- [`ApiPurgeResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeResponse.md)
- [`ApiDeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResponse.md)
- [`ApiUndeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResponse.md)
- [`ApiBlockResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResponse.md)
- [`ApiUnblockResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResponse.md)
- [`ApiWatchResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchResponse.md)
- [`ApiRollbackResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResponse.md)
- [`ApiPatrolResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResponse.md)
- [`ApiOptionsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiOptionsResponse.md)
- [`ApiExpandTemplatesResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResponse.md)
- [`ApiProtectResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResponse.md)
- [`ApiRevisionDeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResponse.md)
- [`ApiCheckTokenResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md)
- [`ApiLanguageSearchResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageSearchResponse.md)
- [`ApiAcquireTempUserNameResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiAcquireTempUserNameResponse.md)
- [`ApiClearHasMsgResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiClearHasMsgResponse.md)
- [`ApiValidatePasswordResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiValidatePasswordResponse.md)
- [`ApiUserrightsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUserrightsResponse.md)
- [`ApiChangeContentModelResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiChangeContentModelResponse.md)
- [`ApiSetPageLanguageResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiSetPageLanguageResponse.md)
- [`ApiManageTagsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsResponse.md)
- [`ApiTagResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiTagResponse.md)
- [`ApiMergeHistoryResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiMergeHistoryResponse.md)
- [`ApiSetNotificationTimestampResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampResponse.md)
- [`ApiEmailUserResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiEmailUserResponse.md)
- [`ApiClientLoginResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiClientLoginResponse.md)
- [`ApiResetPasswordResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiResetPasswordResponse.md)
- [`ApiCreateAccountResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCreateAccountResponse.md)
- [`ApiChangeAuthenticationDataResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiChangeAuthenticationDataResponse.md)
- [`ApiRemoveAuthenticationDataResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRemoveAuthenticationDataResponse.md)
- [`ApiLoginResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLoginResponse.md)
- [`ApiLogoutResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLogoutResponse.md)
- [`ApiFileRevertResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiFileRevertResponse.md)
- [`ApiImageRotateResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateResponse.md)
- [`ApiStashEditResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiStashEditResponse.md)
- [`ApiUploadResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadResponse.md)
- [`ApiImportResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiImportResponse.md)

## Properties

### batchcomplete?

> `optional` **batchcomplete?**: `true`

Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178)

Present and `true` when all data for the current batch of pages has been
returned. Continuation may still be ongoing: the generator runs again for
the next batch of pages, and list/meta modules may continue independently.
Serialized as a real boolean under `formatversion=2`.

***

### curtimestamp?

> `optional` **curtimestamp?**: `string`

Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187)

Current server time (ISO 8601), present when the request set `curtimestamp`.

***

### errorlang?

> `optional` **errorlang?**: `string`

Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199)

Language error messages are rendered in (`responselanginfo=1`).

***

### requestid?

> `optional` **requestid?**: `string`

Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190)

Opaque value echoed back from the request's `requestid` parameter.

***

### servedby?

> `optional` **servedby?**: `string`

Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184)

Identifier of the server that handled the request. Present by default on
error responses; on successful responses only when explicitly requested.

***

### uselang?

> `optional` **uselang?**: `string`

Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196)

Language of the interface strings in the response (`responselanginfo=1`).

***

### warnings?

> `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)

Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193)

Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)).