Skip to main content
POST
/
api
/
camera
/
getCameraAIThresholds
Get camera AI thresholds
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getCameraAIThresholds \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}
'
{
  "consecutiveHumanFilter": 3,
  "consecutiveVehicleFilter": 3,
  "error": true,
  "errorMsg": "<string>",
  "faceConfidenceThreshold": 0.8,
  "faceMatchConfidenceThreshold": 0.5,
  "humanConfidenceThreshold": 0.7,
  "lprConfidenceThreshold": 0.9,
  "maxEventDurationMs": 15000,
  "vehicleConfidenceThreshold": 0.7,
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to retrieve AI thresholds for a camera.

​
cameraUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - application/json

OK

Response containing AI thresholds for a camera.

​
consecutiveHumanFilter
integer<int32> | null

Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.

Example:

3

​
consecutiveVehicleFilter
integer<int32> | null

Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.

Example:

3

​
error
boolean | null
​
errorMsg
string | null
​
faceConfidenceThreshold
number<float> | null

Confidence threshold for face detection. 0 or null means the built-in default.

Example:

0.8

​
faceMatchConfidenceThreshold
number<float> | null
deprecated

Confidence threshold for face matching (determining if two faces are the same person). 0 or null means the built-in default. We no longer support device specific face matching threshold. This property is deprecated and will be removed.

Required range: 0 <= x <= 1
​
humanConfidenceThreshold
number<float> | null

Confidence threshold for human detection. 0 or null means the built-in default.

Example:

0.7

​
lprConfidenceThreshold
number<float> | null

Confidence threshold for license plate detection and character recognition. 0 or null means the built-in default.

Example:

0.9

​
maxEventDurationMs
integer<int32> | null

The max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.

Example:

15000

​
vehicleConfidenceThreshold
number<float> | null

Confidence threshold for vehicle detection. 0 or null means the built-in default.

Example:

0.7

​
warningMsg
string | null