Note We highly recommend not to use the plain HTTP API endpoints. The KoalityEngine provided different SDKs that should be used instead.
This is the official API documentation for the KoalityEngine. It can be used automate workflows in koality.io or even to create a new products or integrate data and functionalities into other products.
This documentation is a living document. If something is missing please contact out support team (support@koality.io).
When using the KoalityEngine API you will often see the Application as a concept. If you just want to use the API to manage your koality.io accounts the application id will be koality, if you create your own independent application you will get your own application id from our team.
We provide a list of standard workflows that should be part of every application that is build on the shoulders of the KoalityEngine.
- Create a new user
- Login with username and password
- Create a new system
- Add new component (url) to project
We automatically generate SDKs for the KoalityEngine API that are updated everytime something at the official API changes. Please be sure to use those SDKs.
The koality.io team is also using those SDKs so you can be sure those are always working.