Skip to main content
Version: 3.0.0 (latest)

API reference

OMNI Agent uses the following HTTP endpoints:

/about​

Retrieves information about the version of OMNI Agent.

Method: GET

Request parameters: —

Response parameters:

  • version: string — version of OMNI Agent.

  • full_version_with_hash: string — version of OMNI Agent with a build hash.

  • build_hash: string — Git commit hash from which OMNI Agent was built.

  • build_date: string — build date of OMNI Agent.

  • name: string — name of OMNI Agent executable file.

  • used_software: object — object describing the versions of the used libraries.

  • FaceSDK: string — version of the Face SDK in use.

  • may_be_standalone: bool — indicates whether the Standalone mode is available.

/preset_activation/<activation_group_id>/<enable|disable>​

Activates or deactivates a group of video analytics scenarios that share the same activation_group_id.

This endpoint is used to control the activation module at the input of a scenario, allowing external systems to enable or disable video analytics without turning off the cameras.

Method: POST

URL parameters:

  • activation_group_id: string — identifier of the scenario group to activate or deactivate.

  • enable|disable: string — action to perform: enable or disable scenarios.

Request body: not required.

Response parameters:

  • status: bool — status indicating whether the request was processed successfully.

/preset_activation​

Returns the current activation state of all known activation_group_id entries registered in the system.

Method: GET

Request parameters: none.

Response parameters: The response contains a JSON object where the key is activation_group_id, and the value is true (active) or false (inactive).

Example successful response:

{
  "EntranceCamera": true,
  "CashRegister": false,
  "DoorSensors": true
}