Skip to main content

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​

idintegeroptional
The profile ID.
keystringoptional
A key derived from the name, such as loading-bay-entry. Cameras refer to profiles by key.
namestringoptional
The display name.
descriptionstring or nulloptional
A description.
colorstringoptional
The label colour in the dashboard: emerald, blue, amber, red, purple or cyan.
target_modestringoptional
ALL passes every class. SELECTED passes only target_classes.
target_classesarray of stringsoptional
The classes that count when target_mode is SELECTED.
trigger_typestringoptional
IMMEDIATE, DWELL_TIME, OBJECT_COUNT, ZONE_ENTRY or ZONE_EXIT.
trigger_configobjectoptional
The trigger settings. See Trigger settings.
trigger_operatorstringoptional
A copy of trigger_config.operator, for convenience.
trigger_valuenumber or nulloptional
A copy of trigger_config.value, for convenience.
severitystringoptional
LOW, MEDIUM, HIGH or CRITICAL.
min_confidencenumber or nulloptional
The lowest detector confidence that counts, above 0 and up to 1. null uses the site default, 0.25 unless your administrator changed it.
schedulestringoptional
ALL_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 nulloptional
Custom active windows that replace schedule. See Schedule windows.
event_type_idinteger or nulloptional
The event type stamped on this profile's events. New profiles get the generic rule_trigger type when you don't set one.
event_type_keystring or nulloptional
The event type's key.
event_type_namestring or nulloptional
The event type's display name.
created_atstringoptional
When the profile was created.

Trigger settings​

trigger_typetrigger_config
IMMEDIATE{}
DWELL_TIMEvalue: seconds, more than 0. operator: > (default) or >=.
OBJECT_COUNTvalue: a count of 1 or more. operator: > (default), >= or ==.
ZONE_ENTRY, ZONE_EXITzone: 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 of mon to sun. Leave it out or empty for every day. A window belongs to the day it starts on.
  • start and end: HH:MM in the site's time zone. If end is earlier than start, 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​

GET/detection-profiles/classes

Lists the object classes the detector model supports. Use these names in target_classes and in rule conditions.

Response fields​

classesarray of stringsoptional
The class names, sorted.

Responses​

200
The classes.
401
You are not signed in.

Draft a profile from a sentence​

POST/detection-profiles/from-natural-language

Turns 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​

textstringrequired
What you want to detect, in plain English.
camera_idintegeroptional
A camera whose zone names the draft may use.

Response fields​

statusstringoptional
VALID, NEEDS_CLARIFICATION, INVALID or ERROR.
ruleobjectoptional
The draft, when status is VALID: name, target_mode, target_classes, trigger_type, trigger_config, severity and schedule.
messagestringoptional
What to clarify or what went wrong, for the other statuses.

Responses​

200
The draft or a message.
401
You are not signed in.
404
No camera with this ID.

List detection profiles​

GET/detection-profiles

Lists every profile, in the order they were created.

Responses​

200
An array of profiles.
401
You are not signed in.

Create a detection profile​

POST/detection-profiles

Creates 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​

namestringrequired
The display name.
descriptionstringoptional
A description.
colorstringoptional
Defaults to emerald.
target_modestringoptional
ALL (the default) or SELECTED.
target_classesarray of stringsoptional
Required when target_mode is SELECTED. Each class must be one from GET /detection-profiles/classes.
trigger_typestringoptional
Defaults to IMMEDIATE.
trigger_configobjectoptional
The trigger settings. See Trigger settings.
severitystringoptional
Defaults to LOW.
min_confidencenumber or nulloptional
Defaults to null, the site default.
schedulestringoptional
Defaults to ALL_DAY.
schedule_windowsarray or nulloptional
Custom windows. Defaults to none.
event_type_idinteger or nulloptional
An event type ID. Defaults to the generic rule_trigger type.

Responses​

200
The profile was created or updated. Returns the profile.
403
You are not an admin.
422
A value is invalid, for example an unknown class, a missing 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​

PATCH/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_idintegerrequired
The profile.

Body​

Any of the fields of Create a detection profile.

Responses​

200
The profile was changed. Returns the profile.
403
You are not an admin.
422
No profile with this ID, or a value is invalid.

Delete a detection profile​

DELETE/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_idintegerrequired
The profile.

Responses​

200
The profile was deleted. The body is {"status": "deleted"}.
400
No profile with this ID, or it is the default profile.
403
You are not an admin.
Was this page helpful?