MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=visualeditoredit
- This module is internal or unstable, and you should not use it. Its operation may change without notice.
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: VisualEditor
- License: MIT
Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
- paction
Action to perform.
- This parameter is required.
- One of the following values: diff, save, serialize, serializeforcache
- page
The page to perform actions on.
- This parameter is required.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- wikitext
The wikitext to act with.
- section
The section on which to act.
- sectiontitle
Title for new section.
- basetimestamp
When saving, set this to the timestamp of the revision that was edited. Used to detect edit conflicts.
- Type: timestamp (allowed formats)
- starttimestamp
When saving, set this to the timestamp of when the page was loaded. Used to detect edit conflicts.
- Type: timestamp (allowed formats)
- oldid
The revision number to use. Defaults to latest revision.
- Type: integer
- minor
Flag for minor edit.
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences (ignored for bot users) or do not change watch.
- html
HTML to send to Parsoid in exchange for wikitext.
- etag
ETag to send.
- summary
Edit summary.
- captchaid
Captcha ID (when saving with a captcha response).
- captchaword
Answer to the captcha (when saving with a captcha response).
- cachekey
Use the result of a previous serializeforcache request with this key. Overrides html.
- nocontent
Omit the HTML content of the new revision in the response.
- Type: boolean (details)
- returnto
Page title. If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to the given page, instead of the page that was edited.
- Type: page title
- Accepts non-existent pages.
- returntoquery
URL query parameters (with leading ?). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given query parameters.
- Default: (empty)
- returntoanchor
URL fragment (with leading #). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given fragment.
- Default: (empty)
- useskin
Apply the selected skin to the parser output. May affect the following properties: text, langlinks, headitems, modules, jsconfigvars, indicators.
- One of the following values: apioutput, authentication-popup, cologneblue, contenttranslation, fallback, json, minerva, modern, monobook, timeless, vector, vector-2022
Change tags to apply to the edit.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- plugins
Plugins associated with the API request.
- ge-task-link-recommendation
- Use when saving a GrowthExperiments "Add a link" structured edit.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- data-{plugin}
Arbitrary data sent by a plugin with the API request.
- For the ge-task-link-recommendation plugin
-
A JSON string of an object with these keys:
- acceptedTargets: (optional) Array with the titles of pages, the recommended link to which was accepted by the user.
- rejectedTargets: (optional) Array with the titles of pages, the recommended link to which was rejected by the user.
- skippedTargets: (optional) Array with the titles of pages, the recommended link to which was skipped (ignored) by the user.
- This is a templated parameter. When making the request, {plugin} in the parameter's name should be replaced with values of plugins.
- mobileformat
Return parse output in a format suitable for mobile devices.
- Type: boolean (details)