Chapter 7

API Documentation

Akumen includes a rich set of API functions to allow programmatic access to Akumen. It is protected through an authentication token, where each user has their own resettable unique key. APIs can be used internally, for example through model execution or pages, or for third party tools and systems to access and update data stored in Akumen.

Note

API calls are case-sensitive! Make sure to double-check to avoid errors!

To find this list of API docs:

  1. Click on the on the settings cog at the top right of the screen.
  2. Go down to Help.
  3. API docs will be at the top of the Help list. API Help List API Help List
  4. The link will take you to an external page that documents all of the API calls.