Skip to main content

Scout AI 2.0

Scout API is a quite simple interface to read and toggle currently used modules. There are 3 available Scout AI modules, on which you can read more here:

  • Scout Vision
  • Scout Predict
  • Scout Cinematic

You can read their state (on / off) on /api/scout:

GET /api/scout
{
"vision": false,
"cinematic": false,
"predict": false
}

To set or toggle state of the given module, send a POST request with body, which keys are identifiers of modules you want to affect. Values can be boolean to set specific state explicitly, or null if you want to toggle current state (true to false or false to true).

Toggling Scout Vision and turning Scout Cinematic off could be done with this example:

POST /api/scout
{
"vision": null,
"cinematic": false
}