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

# Translate

## Interfaces

| Interface                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                        |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [ApiAggregateGroupsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResponse.md)                   | Response of `action=aggregategroups`.                                                                                                                                                                                                                                                                              |
| [ApiAggregateGroupsResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResult.md)                       | Result of `action=aggregategroups` (CSRF-token POST, `translate-manage` right). The fields depend on the requested `do`: creating returns the new group id and the aggregate-able groups, associating returns the target page URL, dissociating and removing return only the marker.                               |
| [ApiGroupReviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiGroupReviewResponse.md)                           | Response of `action=groupreview` (CSRF-token POST, `translate-groupreview` right): the workflow state of one message group for one language was set. Requires `$wgTranslateWorkflowStates` on the wiki; the state names are site-configured.                                                                       |
| [ApiLanguageStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiLanguageStatsRow.md)                                 | One `meta=languagestats` row: completeness of one message group in the requested language.                                                                                                                                                                                                                         |
| [ApiMarkForTranslationResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResponse.md)             | Response of `action=markfortranslation`.                                                                                                                                                                                                                                                                           |
| [ApiMarkForTranslationResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResult.md)                 | Result of `action=markfortranslation` (pagetranslation-token POST, `pagetranslation` right): a wiki page was marked for translation, creating its translation units and the `page-<title>` message group.                                                                                                          |
| [ApiMessageCollectionMetadata](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionMetadata.md)               | The `query.metadata` block `list=messagecollection` writes alongside its rows, describing the requested slice of the collection.                                                                                                                                                                                   |
| [ApiMessageCollectionRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionRow.md)                         | One `list=messagecollection` row: a message of the group named in `mcgroup` for the language named in `mclanguage`. `mcprop` controls which fields beyond the mandatory ones appear.                                                                                                                               |
| [ApiMessageGroupStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupStatsRow.md)                         | One `meta=messagegroupstats` row: completeness of one language in the requested group.                                                                                                                                                                                                                             |
| [ApiMessageGroupSubscriptionResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupSubscriptionResponse.md) | Response of `action=messagegroupsubscription` (CSRF-token POST): the requesting user's subscription to the group was changed. Requires `$wgTranslateEnableMessageGroupSubscription`.                                                                                                                               |
| [ApiMessageTranslation](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageTranslation.md)                             | One `meta=messagetranslations` row: one existing translation of a message (the title named in `mttitle`).                                                                                                                                                                                                          |
| [ApiSearchTranslationsDocument](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsDocument.md)             | One `action=searchtranslations` match: a document of the translation memory. The fields are fixed by the search index; the result may replace `content` with a highlighted snippet.                                                                                                                                |
| [ApiSearchTranslationsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsResponse.md)             | Response of `action=searchtranslations`: full-text search over the translation memories. Only wikis backed by a searchable translation-memory service return hits; the response carries them with a metadata block under the root `search` key.                                                                    |
| [ApiStashedTranslation](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiStashedTranslation.md)                             | One stashed translation of `action=translationstash` `subaction=query`.                                                                                                                                                                                                                                            |
| [ApiTranslateMessageGroup](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateMessageGroup.md)                       | One `meta=messagegroups` entry. `mgprop` controls which fields appear. The groups themselves are site-defined (wiki pages, YAML files, aggregate definitions), so ids beyond the dynamic `!recent` / `!additions` ones are open-ended.                                                                             |
| [ApiTranslateSandboxActionResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxActionResponse.md)     | Response of `action=translatesandbox` with `do=delete` / `do=promote` / `do=remind`: the users were processed, no payload keys are returned.                                                                                                                                                                       |
| [ApiTranslateSandboxCreateResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxCreateResponse.md)     | Response of `action=translatesandbox` with `do=create` (registers a sandboxed translator; requires `$wgTranslateUseSandbox`). The `delete` / `promote` / `remind` variants return no payload — an empty [ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).                         |
| [ApiTranslateStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md)                               | The four completeness counters shared by `meta=languagestats` and `meta=messagegroupstats` rows. A row appears only once its statistics are available; while they are still being computed the result is a continue instead.                                                                                       |
| [ApiTranslateWorkflowState](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateWorkflowState.md)                     | One workflow state of a message group (`meta=messagegroups` + `mgprop=workflowstates`).                                                                                                                                                                                                                            |
| [ApiTranslationAid](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md)                                     | Payload of one translation aid of `action=translationaids`, keyed by aid type (the registry is hook-extensible, so the set is open). An aid that cannot run reports [ApiTranslationAid.error](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md#error) instead of its data. |
| [ApiTranslationAidsPayload](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsPayload.md)                     | The `helpers` map of `action=translationaids`. Members are the aid types of the [TranslationAids registry](https://www.mediawiki.org/wiki/Manual:Hooks/TranslationAids) — the built-in ones are declared here for autocomplete, the index signature keeps hook-registered aids usable.                             |
| [ApiTranslationAidsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsResponse.md)                   | Response of `action=translationaids` (root-level `helpers` and `times`).                                                                                                                                                                                                                                           |
| [ApiTranslationEntitySearchGroup](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchGroup.md)         | One message group match of `action=translationentitysearch`.                                                                                                                                                                                                                                                       |
| [ApiTranslationEntitySearchMessage](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchMessage.md)     | One message prefix match of `action=translationentitysearch`.                                                                                                                                                                                                                                                      |
| [ApiTranslationEntitySearchResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResponse.md)   | Response of `action=translationentitysearch`.                                                                                                                                                                                                                                                                      |
| [ApiTranslationEntitySearchResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResult.md)       | Result of `action=translationentitysearch`: message group and message key prefixes matching the query. Keys are absent when the entity type was not requested or nothing matched.                                                                                                                                  |
| [ApiTranslationReviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationReviewResponse.md)               | Result of `action=translationreview` (CSRF-token POST, `translate-messagereview` right): one translation revision was marked as reviewed. Reviewing one's own translation, fuzzy translations and already reviewed revisions are errors / warnings.                                                                |
| [ApiTranslationStashResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStashResponse.md)                 | Response of `action=translationstash` (CSRF-token POST): `subaction=add` returns only the marker, `subaction=query` additionally lists the stashed translations of the requesting (sandbox) user.                                                                                                                  |
| [ApiTranslationStatsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStatsResponse.md)                 | Response of `action=translationstats`: graph data for the requested series.                                                                                                                                                                                                                                        |
| [ApiTtmServerResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerResponse.md)                               | Response of `action=ttmserver`.                                                                                                                                                                                                                                                                                    |
| [ApiTtmServerSuggestion](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerSuggestion.md)                           | One suggestion of `action=ttmserver`: a translation-memory hit for the requested text. The fields are supplied by the configured translation-memory service; a unit from the local memory carries the fields below.                                                                                                |
