The public API is intended for advanced users that have knowledge of programming and create their own software.
The base endpoint of Aitum related calls is http://localhost:7777/aitum
.
For getting a list of rules and their IDs.
GET /aitum/rules/
Keys in the response refer to their name within Aitum, and the value as their internal ID.
{
"status": "OK",
"data": {
"Test": "TqpYRQEcpXv5hdux"
}
}
For triggering a rule in Aitum by its ID.
GET /aitum/rules/:ruleid
Nothing interesting returned, but this indicates a successful run.
{
"status": "OK",
"data": "OK"
}
For getting a list of state variables and their attached information.
GET /aitum/state/
An array of global variables.
Type values are as follows:
Type | Value |
---|---|
Integer | 0 |
Float | 1 |
String | 2 |
Boolean | 3 |
String Array | 4 |
{
"status": "OK",
"data": [
{
"_id": "Zw1cP6R3wrHVA0gZ",
"name": "test3",
"type": 2,
"value": "asdasd"
},
{
"_id": "o89r2sVwAYufiGnt",
"name": "test",
"type": 2,
"value": "123"
}
]
}