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/extensions/translate/overview.md.
  • English
  • Translate

    Interfaces

    InterfaceDescription
    ApiAggregateGroupsResponseResponse of action=aggregategroups.
    ApiAggregateGroupsResultResult 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.
    ApiGroupReviewResponseResponse 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.
    ApiLanguageStatsRowOne meta=languagestats row: completeness of one message group in the requested language.
    ApiMarkForTranslationResponseResponse of action=markfortranslation.
    ApiMarkForTranslationResultResult 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.
    ApiMessageCollectionMetadataThe query.metadata block list=messagecollection writes alongside its rows, describing the requested slice of the collection.
    ApiMessageCollectionRowOne 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.
    ApiMessageGroupStatsRowOne meta=messagegroupstats row: completeness of one language in the requested group.
    ApiMessageGroupSubscriptionResponseResponse of action=messagegroupsubscription (CSRF-token POST): the requesting user's subscription to the group was changed. Requires $wgTranslateEnableMessageGroupSubscription.
    ApiMessageTranslationOne meta=messagetranslations row: one existing translation of a message (the title named in mttitle).
    ApiSearchTranslationsDocumentOne 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.
    ApiSearchTranslationsResponseResponse 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.
    ApiStashedTranslationOne stashed translation of action=translationstash subaction=query.
    ApiTranslateMessageGroupOne 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.
    ApiTranslateSandboxActionResponseResponse of action=translatesandbox with do=delete / do=promote / do=remind: the users were processed, no payload keys are returned.
    ApiTranslateSandboxCreateResponseResponse of action=translatesandbox with do=create (registers a sandboxed translator; requires $wgTranslateUseSandbox). The delete / promote / remind variants return no payload — an empty ApiEnvelope.
    ApiTranslateStatsRowThe 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.
    ApiTranslateWorkflowStateOne workflow state of a message group (meta=messagegroups + mgprop=workflowstates).
    ApiTranslationAidPayload 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 instead of its data.
    ApiTranslationAidsPayloadThe helpers map of action=translationaids. Members are the aid types of the TranslationAids registry — the built-in ones are declared here for autocomplete, the index signature keeps hook-registered aids usable.
    ApiTranslationAidsResponseResponse of action=translationaids (root-level helpers and times).
    ApiTranslationEntitySearchGroupOne message group match of action=translationentitysearch.
    ApiTranslationEntitySearchMessageOne message prefix match of action=translationentitysearch.
    ApiTranslationEntitySearchResponseResponse of action=translationentitysearch.
    ApiTranslationEntitySearchResultResult 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.
    ApiTranslationReviewResponseResult 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.
    ApiTranslationStashResponseResponse of action=translationstash (CSRF-token POST): subaction=add returns only the marker, subaction=query additionally lists the stashed translations of the requesting (sandbox) user.
    ApiTranslationStatsResponseResponse of action=translationstats: graph data for the requested series.
    ApiTtmServerResponseResponse of action=ttmserver.
    ApiTtmServerSuggestionOne 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.