FAF API

Health

get
https://faf.traces.cloud/
api/v1/health
health

Example

Bash
1
curl -X GET "http://faf.traces.cloud.api/v1/health" -H "accept: */*"
Copied!

Operations

post
https://faf.traces.cloud/
api/v1/filter-alarm
filter-alarm

Example

An example of a request with 5 frames.
Bash
1
curl -X POST "http://faf.traces.cloud/api/v1.1/filter-alarm"
2
-H "accept: */*"
3
-H "X-Traces-API-Key: YOUR_API_KEY"
4
-H "Content-Type: multipart/form-data"
5
-F "metadata={ "event_id": "ddf27b34-d3b5-41a5-b2a6-3873a589ec09", "camera_id": "b5271b30-aecd-4897-bc95-ff25c8466b9e", "timestamp": 1585840725 }" -F
6
"[email protected]_frame0.png;type=image/png" -F "[email protected]_frame1.png;type=image/png" -F "[email protected]_frame2.png;type=image/png" -F "[email protected]_frame3.png;type=image/png" -F "[email protected]_frame4.png;type=image/png"
Copied!
An example of a request with 12 frames.
1
curl -X POST "http://faf.traces.cloud/api/v1.1/filter-alarm"
2
-H "accept: */*"
3
-H "X-Traces-API-Key: YOUR_API_KEY"
4
-H "Content-Type: multipart/form-data"
5
-F "metadata={ "event_id": "ddf27b34-d3b5-41a5-b2a6-3873a589ec09", "camera_id": "b5271b30-aecd-4897-bc95-ff25c8466b9e", "timestamp": 1585840725 }"
6
-F "[email protected]_frame0.png;type=image/png"
7
-F "[email protected]_frame1.png;type=image/png"
8
-F "[email protected]_frame2.png;type=image/png"
9
-F "[email protected]_frame3.png;type=image/png"
10
-F "[email protected]_frame4.png;type=image/png"
11
-F "[email protected]_frame5.png;type=image/png"
12
-F "[email protected]_frame6.png;type=image/png"
13
-F "[email protected]_frame7.png;type=image/png"
14
-F "[email protected]_frame8.png;type=image/png"
15
-F "[email protected]_frame9.png;type=image/png"
16
-F "[email protected]_frame10.png;type=image/png"
17
-F "[email protected]_frame11.png;type=image/png"
Copied!
post
https://faf.traces.cloud/
api/v1/filter-video-alarm
filter-video-alarm

Examples of Alarm Responses to different motion events

Example of False Alarm

Input data
Click to Zoom
FAF Response
1
{
2
"alarm_confirmed": false,
3
"alarm_confidence": null,
4
"triggered_by": []
5
}
Copied!

Example of an alarm triggered by a "Person"

Input data
Click to Zoom
FAF Response
1
{
2
"alarm_confirmed": true,
3
"alarm_confidence": 0.7866996370706637,
4
"triggered_by": [
5
{
6
"object_type": "person",
7
"action": "moving",
8
"bbox": [
9
621,
10
1051,
11
711,
12
1269
13
],
14
"frame_id": 0,
15
"direction": null
16
},
17
{
18
"object_type": "person",
19
"action": "moving",
20
"bbox": [
21
959,
22
1100,
23
1031,
24
1337
25
],
26
"frame_id": 0,
27
"direction": null
28
},
29
{
30
"object_type": "person",
31
"action": "moving",
32
"bbox": [
33
718,
34
1148,
35
815,
36
1368
37
],
38
"frame_id": 0,
39
"direction": null
40
},
41
{
42
"object_type": "person",
43
"action": "moving",
44
"bbox": [
45
769,
46
977,
47
859,
48
1233
49
],
50
"frame_id": 1,
51
"direction": null
52
},
53
{
54
"object_type": "person",
55
"action": "moving",
56
"bbox": [
57
687,
58
971,
59
771,
60
1189
61
],
62
"frame_id": 1,
63
"direction": null
64
},
65
{
66
"object_type": "person",
67
"action": "moving",
68
"bbox": [
69
940,
70
983,
71
1026,
72
1217
73
],
74
"frame_id": 1,
75
"direction": null
76
},
77
{
78
"object_type": "person",
79
"action": "moving",
80
"bbox": [
81
983,
82
875,
83
1059,
84
1086
85
],
86
"frame_id": 2,
87
"direction": null
88
},
89
{
90
"object_type": "person",
91
"action": "moving",
92
"bbox": [
93
833,
94
886,
95
894,
96
1121
97
],
98
"frame_id": 2,
99
"direction": null
100
},
101
{
102
"object_type": "person",
103
"action": "moving",
104
"bbox": [
105
738,
106
871,
107
816,
108
1080
109
],
110
"frame_id": 2,
111
"direction": null
112
}
113
]
114
}
Copied!

Example of an alarm triggered by "Vehicle"

Input data
Click to Zoom
FAF Response
1
{
2
"alarm_confirmed": true,
3
"alarm_confidence": 0.7540868690800507,
4
"triggered_by": [
5
{
6
"object_type": "vehicle",
7
"action": "moving",
8
"bbox": [
9
2084,
10
604,
11
2420,
12
774
13
],
14
"frame_id": 0,
15
"direction": null
16
},
17
{
18
"object_type": "vehicle",
19
"action": "moving",
20
"bbox": [
21
1433,
22
456,
23
1723,
24
588
25
],
26
"frame_id": 1,
27
"direction": null
28
},
29
{
30
"object_type": "vehicle",
31
"action": "moving",
32
"bbox": [
33
805,
34
514,
35
1104,
36
699
37
],
38
"frame_id": 2,
39
"direction": null
40
}
41
]
42
}
Copied!

Example of an alarm triggered by both "Person" and "Vehicle"

Input data
Click to Zoom
FAF Response
1
{
2
"alarm_confirmed": true,
3
"alarm_confidence": 0.6292241402835548,
4
"triggered_by": [
5
{
6
"object_type": "vehicle",
7
"action": "moving",
8
"bbox": [
9
677,
10
486,
11
925,
12
653
13
],
14
"frame_id": 0,
15
"direction": null
16
},
17
{
18
"object_type": "person",
19
"action": "moving",
20
"bbox": [
21
447,
22
195,
23
496,
24
269
25
],
26
"frame_id": 0,
27
"direction": null
28
},
29
{
30
"object_type": "vehicle",
31
"action": "moving",
32
"bbox": [
33
673,
34
466,
35
923,
36
653
37
],
38
"frame_id": 1,
39
"direction": null
40
},
41
{
42
"object_type": "person",
43
"action": "moving",
44
"bbox": [
45
588,
46
393,
47
624,
48
495
49
],
50
"frame_id": 1,
51
"direction": null
52
},
53
{
54
"object_type": "vehicle",
55
"action": "moving",
56
"bbox": [
57
584,
58
468,
59
814,
60
620
61
],
62
"frame_id": 2,
63
"direction": null
64
}
65
]
66
}
Copied!

EventMetadata

Key
Type
Description
Camera_id
str
A unique ID number of the video camera. Used for AI auto training pipeline, consensus algorithm, and billing.
Timestamp
int
A timestamp in seconds since the epoch
Event_id
str
A unique ID of the event.
Used for synchronization and AI auto training pipeline.
Last modified 3mo ago