API docs

The API provides access to DiSARM algorithms, functions and models. Each algorithm can be accessed headless (i.e. via http request without an interface) or via a simple user interface (UI). See Algorithm-specific docs for a list of each algorithm available and links to the UIs and source code.

There is a playlist available of the complete set of DiSARM API and application walkthroughs.

Terms

We can deploy almost any function to the OpenFaas platform, so the following terms are used interchangeably: functions, algorithms, models, etc.

General instructions

The simplest example of a synchronous request with parameters would be something like:

curl --request 'POST' \
    --data '{"delay_s":0.5}'  \
    https://faas.srv.disarm.io/function/longrun

There are detailed instructions for running the functions in development (e.g. using curl) and in production (e.g. from Python).

Note: HTTPie might be a useful alternative command line client for HTTP requests.

Data

• Datasets [coming]

• ​Structuring JSON​

Creating, deploying

• ​Creating and deploying a new algorithm on DiSARM OpenFaas​

• ​Versioning​

Testing, debugging

• ​Troubleshooting functions​

• ​Testing local function containers​

• ​Running for test/dev​

Using

• ​Running in production​

• ​Logging and monitoring​

Infrastructure

• ​DiSARM API Infrastructure​