Detection profiles
See Detection profiles for what each setting does.
Reading endpoints work for operators and admins. Endpoints that change profiles need the admin role. Changes take effect within about 30 seconds.
The profile object
idintegeroptionalkeystringoptionalloading-bay-entry. Cameras refer to profiles by key.namestringoptionaldescriptionstring or nulloptionalcolorstringoptionalemerald, blue, amber, red, purple or cyan.target_modestringoptionalALL passes every class. SELECTED passes only target_classes.target_classesarray of stringsoptionaltarget_mode is SELECTED.trigger_typestringoptionalIMMEDIATE, DWELL_TIME, OBJECT_COUNT, ZONE_ENTRY or ZONE_EXIT.trigger_configobjectoptionaltrigger_operatorstringoptionaltrigger_config.operator, for convenience.trigger_valuenumber or nulloptionaltrigger_config.value, for convenience.severitystringoptionalLOW, MEDIUM, HIGH or CRITICAL.min_confidencenumber or nulloptional0 and up to 1. null uses the site default, 0.25 unless your administrator changed it.schedulestringoptionalALL_DAY, BUSINESS_HOURS (08:00 to 22:00) or AFTER_HOURS (22:00 to 08:00). Times are in the site's time zone. Ignored when schedule_windows is set.schedule_windowsarray or nulloptionalschedule. See Schedule windows.event_type_idinteger or nulloptionalrule_trigger type when you don't set one.event_type_keystring or nulloptionalevent_type_namestring or nulloptionalcreated_atstringoptionalTrigger settings
trigger_type | trigger_config |
|---|---|
IMMEDIATE | {} |
DWELL_TIME | value: seconds, more than 0. operator: > (default) or >=. |
OBJECT_COUNT | value: a count of 1 or more. operator: > (default), >= or ==. |
ZONE_ENTRY, ZONE_EXIT | zone: the name of one of the camera's zones. Leave it out to use any of the camera's zones. |
For people, Argus tests the bottom centre of the detection box (where the feet are) against the zone. For other objects it uses the centre of the box.
Schedule windows
schedule_windows is a list of up to 28 windows:
[
{ "days": ["mon", "tue", "wed", "thu", "fri"], "start": "18:00", "end": "07:00" },
{ "days": ["sat", "sun"], "start": "00:00", "end": "00:00" }
]
days: any ofmontosun. Leave it out or empty for every day. A window belongs to the day it starts on.startandend:HH:MMin the site's time zone. Ifendis earlier thanstart, the window runs past midnight. If they are equal, the window covers the whole day.
Send null or [] to go back to the schedule preset.
List detectable classes
Draft a profile from a sentence
/detection-profiles/from-natural-languageTurns a sentence such as "Alert when a person enters the loading dock" into a draft profile. The site's local language model writes the draft and Argus checks it against the detectable classes and the camera's zones. Nothing is saved: review the draft, then send it to Create a detection profile. Works for operators and admins.
Body
textstringrequiredcamera_idintegeroptionalResponse fields
statusstringoptionalVALID, NEEDS_CLARIFICATION, INVALID or ERROR.ruleobjectoptionalstatus is VALID: name, target_mode, target_classes, trigger_type, trigger_config, severity and schedule.messagestringoptionalResponses
List detection profiles
Create a detection profile
/detection-profilesCreates a profile. Argus derives the key from the name. If a profile with that key already exists, it is updated instead. Requires the admin role.
Body
namestringrequireddescriptionstringoptionalcolorstringoptionalemerald.target_modestringoptionalALL (the default) or SELECTED.target_classesarray of stringsoptionaltrigger_typestringoptionalIMMEDIATE.trigger_configobjectoptionalseveritystringoptionalLOW.min_confidencenumber or nulloptionalnull, the site default.schedulestringoptionalALL_DAY.schedule_windowsarray or nulloptionalevent_type_idinteger or nulloptionalrule_trigger type.Responses
value for a dwell or count trigger, an unknown severity, a confidence outside 0 to 1, a bad schedule window or an unknown event type.Change a detection profile
/detection-profiles/{profile_id}Changes one or more fields. Send only the fields you want to change. The key stays the same even if you change the name. Leave out min_confidence or schedule_windows to keep them; send null to reset them. Requires the admin role.
Path parameters
profile_idintegerrequiredBody
Any of the fields of Create a detection profile.
Responses
Delete a detection profile
/detection-profiles/{profile_id}Deletes a profile. Cameras that used it switch to the default profile. You can't delete the default profile. Requires the admin role.
Path parameters
profile_idintegerrequiredResponses
{"status": "deleted"}.default profile.