<div class="hlist plainlinks api-main-links">
* [[mw:API:Main_page|Documentation]]
* [[mw:API:FAQ|FAQ]]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api Mailing list]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce API Announcements]
* [https://phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R Bugs & requests]
</div>
<strong>Status:</strong> All features shown on this page should be working, but the API is still in active development, and may change at any time. Subscribe to [https://lists.wikimedia.org/pipermail/mediawiki-api-announce/ the mediawiki-api-announce mailing list] for notice of updates.

<strong>Erroneous requests:</strong> When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see [[mw:API:Errors_and_warnings|API: Errors and warnings]].

<strong>Testing:</strong> For ease of testing API requests, see [[Special:ApiSandbox]].

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like <kbd>https://en.wikipedia.org</kbd> or <kbd>https://meta.wikimedia.org</kbd>. If this parameter does not match the <code>Origin</code> header, a 403 response will be returned. If this parameter matches the <code>Origin</code> header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like <kbd>https://en.wikipedia.org</kbd> or <kbd>https://meta.wikimedia.org</kbd>. If this parameter does not match the <code>Origin</code> header, a 403 response will be returned. If this parameter matches the <code>Origin</code> header and the origin is whitelisted, the <code>Access-Control-Allow-Origin</code> and <code>Access-Control-Allow-Credentials</code> headers will be set.

For non-authenticated requests, specify the value <kbd>*</kbd>. This will cause the <code>Access-Control-Allow-Origin</code> header to be set, but <code>Access-Control-Allow-Credentials</code> will be <code>false</code> and all user-specific data will be restricted.

The title of the article to link. If this parameter is an empty string or both linktitle and badges are not set, the link will be removed.

Use this form to import HTML content into your wiki.

If you upload a zip file, the Collection Name field is used to differentiate the collection from a later version. Also all files will be grouped in a category by the same name. For example, let's say you're importing a collection of HTML files output from your software documentation system, you would enter a unique Collection ID like 'FluxCapacitor-v1.1' so that the whole collection is imported into an article hierarchy starting with 'FluxCapacitor-v1.1'. This way 10 different collections can be imported without clobbering each other.

Specifying an existing Collection Name (or parent path) will update existing wiki content.

If you want to import a single file into an existing article hierarchy, simply specify it's 'parent' as the Collection Name.

For example, if importing a new 'advanced_topics.html' that should exist at <code>'FluxCapacitor-v1.1/docs/advanced_topics.html'</code>, the parent would be 'FluxCapacitor-v1.1/docs/'

Archive format used when enabling Flow on existing pages. This is a format string. %s and %d should be present. %s represents the title of the page where Flow is being enabled. %d represents a number that will be incremented if an archive page with the same name already exist. Multiple formats can be specified separated by the new line character (\n).

Archive format used when archiving a Flow page. This is a format string. %s and %d should be present. %s represents the title of the Flow page being archived. %d represents a number that will be incremented if an archive page with the same name already exist. Multiple formats can be specified separated by the new line character (\n).

The MediaWiki template may have a <code>permission</code> parameter; when it does, an attempt to detect the copyright licence based on the metadata value can be made. GWToolset looks for Creative Commons URLs that match possible copyright licences; e.g., https://creativecommons.org/licenses/by-sa/3.0/ matches the MediaWiki licence template <code>{{tl|Template:Cc-by-sa-3.0}}</code>. If this checkbox is left unchecked, the raw metadata value for each item in the batch upload will be placed in the permission parameter.

The MediaWiki template may have a <code>permission</code> parameter. When it does, an attempt to detect the copyright license based on the metadata value can be made. GWToolset looks for Creative Commons URLs that match possible copyright licenses, e.g., https://creativecommons.org/licenses/by-sa/3.0/ matches the MediaWiki license template <code>{{tl|Template:Cc-by-sa-3.0}}</code>. If this box is left unchecked, the raw metadata value for each item in the batch upload will be placed in the permission parameter.

Return URL for third-party authentication flows, must be absolute. Either this or <var>$1continue</var> is required.

Upon receiving a <samp>REDIRECT</samp> response, you will typically open a browser or web view to the specified <samp>redirecttarget</samp> URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a <var>$1continue</var> request to this API module.

When feedback is to be discussed on the user's talk page, this is the content template that will be provided.

Parameters:
* $1 - (Unused) the user that submitted the feedback (either the IP for anonymous user, or in the format [[User:Name|Name]] for registered users)
* $2 - (Unused) the permalink to the feedback that'll be discussed
* $3 - the date the feedback was submitted
* $4 - (Unused) the time the feedback was submitted
* $5 - the link to all feedback on this article
* $6 - the full feedback comment (will be empty in the event that feedback text is short and fits in the section title)
* $7 - the title of the page the feedback was submitted for

When feedback is to be discussed on the article's talk page, this is the content template that will be provided.

Parameters:
* $1 - the user that submitted the feedback (either the IP for anonymous user, or in the format [[User:Name|Name]] for registered users)
* $2 - the permalink to the feedback that'll be discussed
* $3 - the date the feedback was submitted
* $4 - (Unused) the time the feedback was submitted
* $5 - the link to all feedback on this article
* $6 - the full feedback comment (will be empty in the event that feedback text is short and fits in the section title)
* $7 - (Unused) the title of the page the feedback was submitted for

 #<!-- leave this line exactly as it is --> <pre>
# This message lets you configure the settings of the "more like this" feature.
# Changes to this take effect immediately.
# The syntax is as follows:
#  * Everything from a "#" character to the end of the line is a comment.
#  * Every non-blank line is the setting name followed by a ":" character followed by the setting value
# The settings are:
#  * min_doc_freq (integer): Minimum number of documents (per shard) that need a term for it to be considered.
#  * max_doc_freq (integer): Maximum number of documents (per shard) that have a term for it to be considered.
#                  High frequency terms are generally "stop words".
#  * max_query_terms (integer): Maximum number of terms to be considered. This value is limited to $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit (100).
#  * min_term_freq (integer): Minimum number of times the term appears in the input to doc to be considered. For small fields (title) this value should be 1.
#  * minimum_should_match (percentage -100% to 100%, or integer number of terms): The percentage of terms to match on. Defaults to 30%.
#  * min_word_len (integer): Minimal length of a term to be considered. Defaults to 0.
#  * max_word_len (integer): The maximum word length above which words will be ignored. Defaults to unbounded (0).
#  * fields (comma separated list of values): These are the fields to use. Allowed fields are title, text, auxiliary_text, opening_text, headings and all.
#  * use_fields (true|false) : Tell the "more like this" query to use only the field data. Defaults to false: the system will extract the content of the text field to build the query.
# Examples of good lines:
# min_doc_freq:2
# max_doc_freq:20000
# max_query_terms:25
# min_term_freq:2
# minimum_should_match:30%
# min_word_len:2
# max_word_len:40
# fields:text,opening_text
# use_fields:true
# </pre> <!-- leave this line exactly as it is -->

#<!-- leave this line exactly as it is --> <pre>
# This message lets you configure the settings of the "more like this" feature.
# Changes to this take effect immediately.
# The syntax is as follows:
#  * Everything from a "#" character to the end of the line is a comment.
#  * Every non-blank line is the setting name followed by a ":" character followed by the setting value
# The settings are:
#  * min_doc_freq (integer): Minimum number of documents (per shard) that need a term for it to be considered.
#  * max_doc_freq (integer): Maximum number of documents (per shard) that have a term for it to be considered.
#                  High frequency terms are generally "stop words".
#  * max_query_terms (integer): Maximum number of terms to be considered. This value is limited to $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit (100).
#  * min_term_freq (integer): Minimum number of times the term appears in the input to doc to be considered. For small fields (title) this value should be 1.
#  * minimum_should_match (percentage -100% to 100%, or integer number of terms): The percentage of terms to match on. Defaults to 30%.
#  * min_word_len (integer): Minimal length of a term to be considered. Defaults to 0.
#  * max_word_len (integer): The maximum word length above which words will be ignored. Defaults to unbounded (0).
#  * fields (comma separated list of values): These are the fields to use. Allowed fields are title, text, auxiliary_text, opening_text, headings and all.
#  * use_fields (true|false) : Tell the "more like this" query to use only the field data. Defaults to false: the system will extract the content of the text field to build the query.
# Examples of good lines:
# min_doc_freq:2
# max_doc_freq:20000
# max_query_terms:25
# min_term_freq:2
# minimum_should_match:30%
# min_word_len:2
# max_word_len:40
# fields:text,opening_text
# use_fields:true
# </pre> <!-- leave this line exactly as it is -->

Information about how to proceede to create a new item. This message is presented when a user searched (or requested by URL) for an item by site and page title (e.g. item, linked to a particular Wikipedia page in a particular language), but no item was found that linked to that page.  This gives the user the option to create a new item with the page title as the item label.  The user will be sent to the Create item page and the label would be pre-populated.

Parameters:
* $1 - the URL string with the site identifier and page name

Parameter to indicate the mapping service to use with this function.
This will allow maps to override the default value of the service parameter by the one that is optimal for the mapping service.
(Example: In case of Google Maps, the Google geocoder will be used.)

The projects to list pages for. If this parameter is omitted, all projects will be included.

Longer explanation of an option when creating a form

This describes one parameter to the "tree" form input, that takes in wikitext and sets the structure. The wikitext that should be entered for this parameter should look something like:
* A
** B
** C
*** D
* E

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use <kbd>[[Special:ApiHelp/centralauthtoken|action=centralauthtoken]]</kbd> on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

The IDs of items to be set as badges. They will replace the current ones. If this parameter is not set, the badges will not be changed

This is an information message for the field on [[Special:Ask]] that contains the code of a query that may be copied and when pasted into a regular page on the wiki..

Perform a prefix search for page titles.

Despite the similarity in names, this module is not intended to be equivalent to [[Special:PrefixIndex]]; for that, see <kbd>[[Special:ApiHelp/query+allpages|action=query&list=allpages]]</kbd> with the <kbd>apprefix</kbd> parameter. The purpose of this module is similar to <kbd>[[Special:ApiHelp/opensearch|action=opensearch]]</kbd>: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.

Using the form below will rename a page, moving all of its history to the new name.
The old title will become a redirect page to the new title.
You can update redirects that point to the original title automatically.
If you choose not to, be sure to check for [[Special:DoubleRedirects|double]] or [[Special:BrokenRedirects|broken redirects]].
You are responsible for making sure that links continue to point where they are supposed to go.

Note that the page will <strong>not</strong> be moved if there is already a page at the new title, unless the latter is a redirect and has no past edit history.
This means that you can rename a page back to where it was renamed from if you make a mistake, and you cannot overwrite an existing page.

<strong>Note:</strong>
This can be a drastic and unexpected change for a popular page;
please be sure you understand the consequences of this before proceeding.

<strong>The tag "$1" is still active, and will continue to be applied in the future.</strong> To stop this from happening, go to the place(s) where the tag is set to be applied, and disable it there.

Used to display the default value for an API parameter when that default is an empty value

See also:
* {{msg-mw|api-help-param-default}}