Public API

An overview of Aitums public API

The public API is intended for advanced users that have knowledge of programming and create their own software.

Aitum has a public API, allowing you to extend Aitum’s functionality into your own third-party tools and applications. The public API runs only on your main Aitum instance, and not on any workers (although this may change in the future).

The API port is 7777 and cannot be changed. There is no authentication on the API, and it is not intended to be exposed outside of your local network. Please do not expose the API to the internet as there could be serious security implications.

Usage methodology

Aitum is an event driven application. This API is intended to be used alongside existing functionality inside Aitum.

For example, using the Twitch Hype Train method as an example, a third party application would have no indication that a hype train had started. This is where Aitum should be used to “notify” the third party app that a change has occurred, be it via HTTP GET or other means (using shell exec). Once the third party app receives this notification, it should then make an API call and grab the relevant information.

API reference

The base endpoint for the Aitum public API is http://localhost:7777/.

You can find information about the API methods here:

Aitum - Methods relating to Aitum itself
Twitch - Methods relating to Twitch

Response format

All responses will return in the following JSON form:

{
  "status": "OK",
  "data": {}
}