Extension:StructuredDiscussions/API


 * See also Flow/Architecture/API and 

Most Flow API read and write interactions are submodules of. Flow also implements a query property  and a parsing utility module.

Detection
(details below) is one way to check if Flow is enabled on the specified pages.

You can alternatively use  to retrieve page info including content model. The content model will be 'flow-board' if it's enabled. Compare https://en.wikipedia.org/w/api.php?action=query&titles=Wikipedia%20talk:WikiProject%20Breakfast&prop=info and https://en.wikipedia.org/w/api.php?action=query&titles=Wikipedia%20talk:Articles%20for%20deletion&prop=info.

In client-side JavaScript (for gadgets and user scripts), call.

action=flow
All action=flow requests take the following parameters:


 * : The specific flow submodule you want to use. See below for documentation on some of them
 * : Id of the workflow to take action upon
 * : Page title of the page to take action upon
 * : An edit token (see API:Tokens). This is required for all write modules.
 * : Include this to have an HTML rendering be returned in the output. Used by the extension's JS modules.

For any action that posts data, you will need a token, which defeats cross-site request forgery. To get this, use meta=tokens:

new-topic
(Since this edit operation has to be an HTTP POST, the link in the generated example above won't work.)