The exposed Appian RPA API is a REST API. This format makes it far easier to invoke the functionality available in the API from other systems, even by using commands from different operating systems.


A typical URL to call the API methods matches the following format: **


  • protocol is "https".
  • rpa-server is the domain and the context of the Appian RPA console, for example "".
  • specific-part-for-the-method is the API method to be invoked. Some methods may need parameters.

The URL shown in the API methods section of this document corresponds to <method-path>.


API keys can be used to authenticate with the Appian RPA REST API.

If the service account has an administrator role in Appian, it will have an administrator role in Appian RPA. If the service account has a designer role in Appian, it will have a developer role in Appian RPA.

When making REST call to Appian RPA, the API Key must be sent as a Bearer Token:

  • Bearer Token Header:
    curl<method-path> -H "Authorization: Bearer ${API_KEY}"


HTTP Verbs

Every API method must be invoked using the HTTP verb described on their corresponding specifications.

The read methods will commonly use the GET verb, the update ones will use PUT or POST, those removing information DELETE, etc.


All the parameters must be included as the HTTP GET requests do, i.e., using query parameters, with the following exceptions:

The authentication method uses the verb HTTP POST with the request body of type x-www-form-urlencoded.

The method for the execution of robots with parameters uses the verb HTTP POST with the request body of type raw (application/json).

This information is included in every method specification.


The responses to the requests will always be obtained in JSON format. Except for the authentication method, the responses will always include the following attributes:


It represents the result of the call. Its possible values are:

  • OK: If the call has been successfully completed.
  • KO: If the call has not been successfully completed.
  • EXCEPTION: If the call caused a server failure. It is unusual to obtain this kind of result in the API calls. In case it occurs, contact your Appian RPA administrator.


It represents the functional result of the call. Its value varies depending on the request made. The details can be found in every method specification described in this document.

This version of the Appian RPA documentation was written for Appian 20.4, and does not represent the interfaces or functionality of other Appian versions.
Open in Github Built: Fri, Dec 03, 2021 (02:38:50 PM)

On This Page