How to Create an Alert rule

The API endpoint for creating alert rules is https://{VMS_URL}/api/v3/alert_rules/

The example value from the Swagger can be used with a configured meta field:

Expected Alert Rule Parameters

The most important part of the alert rule is the meta field.

Expected meta for Facial Recognition alert rule:

CODE

"meta": {
    "CloudMeta": "true",
    "FacialRecognition": "AWS",
    "indexes": "firstname-lastname-1738375179381",
    "face_collection": "someCollection"
}

Expected meta for Object Detection alert rule:

CODE

"meta": {
    "CloudMeta": "true",
    "ObjectDetection": "AWS",
    "indexes": "laptop,chair,pencil"
}

Expected meta for ChatGPT alert rule:

CODE

"meta": {
    "CloudMeta": "true",
    "LLM": "bedrock",
    "llm_request": "Is there any slip and fall hazards?"
}

Expected meta for Non-AI alert rule:

CODE

"meta": {
    "CloudMeta": "false"
}