API > Introduction

The MindMeister API consists of a set of callable methods and API endpoints. The arguments, responses, and error codes for each method are listed in the Methods section.

To perform an action using the MindMeister API, send a request (specifying a method and some parameters) to an API endpoint. A response will then be sent back to you.

All requests take a list of named parameters.

The required parameter method is used to specify the method to be called.

The required parameter api_key is used to specify your API Key.

The REST format is a simple XML-based protocol – it is a conventional HTTP GET or POST action.

The REST endpoint URL is http://www.mindmeister.com/services/rest/.

Alternatively, the endpoint is available over HTTPS at https://www.mindmeister.com/services/rest/.

To request the mm.test.echo service, you would invoke the following:

http://www.mindmeister.com/services/rest/?method=mm.test.echo&api_key=123456789DEADBEEF&name=value

All responses are, by default, returned in a REST-friendly XML format. This includes a valid xml header (which is not shown in the examples):

<?xml version="1.0" encoding="UTF-8"?>

Successful Response

<rsp stat="ok">
    <api_key>123456789DEADBEEF</api_key>
    <foo>bar</foo>
    <method>mm.test.echo</method>
  </rsp>

Failure Response

<rsp stat="fail">
    <err code="112" msg="Method "mm.test.abracadarba" not found"/>
  </rsp>

Back to Home