HTTP APIs
Getting Started
Before you read this part, please make sure to read How our APIs workto understand the interaction between data in our platform.
Postman Documentation
Click the link below to access Postman Documentation for easier use for our HTTP API:
Streams
This section is used for stream configuration. If you want to create your visualization then this API will help you to connect the camera RTSP / RTMP address to be consumed by our engine.
Get All Streams
This API will give you all streams in all nodes (in case you use clustering deployment).
Success
11
Get All Stream in a Node
This API will give you all streams in spesific node.
Success
11
Create stream connection
This API will create a stream connection from RTSP address. You can enable or disable camera stream from active
boolean value.
true
"rtsp://10.7.2.50:554/VOD/halte_unj_crd.mp4"
"CCTV Halte - Active"
Create disabled stream connection / Create active stream connection
false
200
"stream successfully created"
0
true
"rtsp://10.7.2.50:554/VOD/halte_unj_crd.mp4"
"8a871ad5641538ac"
"CCTV Halte - Disabled"
Get Specific Stream Detail
This API will give you detail information about stream status (from resolution to fps) and also analytics status (how many analytics assigned).
Result without Analytics / Result with Analytics
true
"rtsp://10.7.2.50:554/VOD/halte_unj_crd.mp4"
"c73a1992f67961d1"
0
0
"halte slave 11"
0
Update stream connection
This API will update information for stream connection. Make sure to include all body request when you use this API.
true
"rtsp://10.7.2.50:554/VOD/halte_unj_crd.mp4"
-6.261376228442297
106.82364878415255
"CCTV Halte Jakarta"
Success
true
200
"stream successfully updated"
0
"rtsp://10.7.2.50:554/VOD/halte_unj_crd.mp4"
"b90694a235dc4bf3"
"CCTV Halte Jakarta"
Delete stream connection
This API will delete (permanently) stream connection. If you have analytic assigned from this stream connection, it will automatically delete the analytic.
Delete stream connection
200
"stream successfully deleted"
0
"b90694a235dc4bf3"
Analytics Pipeline
Pipeline is a process where we assign specific analytic(s) to a stream.
POST Face Recognition Analytic
POST Face Recognition Analytic
true
3
0
0
0.4
0.4
true
0.7
50
Success without blacklist area / Success with blacklist area
"NFV4-FR"
200
"pipeline successfully created"
0
"1f49ae135b4fa44b"
DELETE Face Recognition Pipeline
DELETE Face Recognition Pipeline
Success delete analytic pipeline
"NFV4-FR"
200
"pipeline successfully deleted"
0
"1f49ae135b4fa44b"
POST People Analytics
POST People Analytics
Success create all logics / Success create density logic / Success create dwelling logic / Success create counting logic
"NFV4-MPA"
200
"pipeline successfully created"
0
"1f49ae135b4fa44b"
POST Vehicle Analytics
POST Vehicle Analytics
Success create all logics / Success create density logic / Success create dwelling logic / Success create counting logic
"NFV4-MPA"
200
"pipeline successfully created"
0
"1f49ae135b4fa44b"
POST License Plate Recognition 2
POST License Plate Recognition 2
20
2
20
5
0.7
false
0.7
0.7
Success
"NFV4-LPR2"
200
"pipeline successfully created"
0
"0e08b38c86161ae9"
For the API below, the body request will be used in People Counting, Vehicle Counting, and Head Counting the only difference is the analytics codification. For People Counting use NFV4-PC
, Vehicle Counting use NFV4-VC
and Head Counting use NFV4-HC
.
POST People Counting
POST People Counting
0.7
Success
"NFV4-PC"
200
"pipeline successfully created"
0
"0e08b38c86161ae9"
POST Water Level Monitoring
POST Water Level Monitoring
10
Success
"NFV4-WLM"
200
"pipeline successfully created"
0
"0e08b38c86161ae9"
POST Crowd Estimation
POST Crowd Estimation
10
Success
"NFV4-CE"
200
"pipeline successfully created"
0
"0e08b38c86161ae9"
POST PPE
POST PPE
0.85
5
10
0.6
0.85
Success
"NFV4-PPE"
200
"pipeline successfully created"
0
"0e08b38c86161ae9"
Others
GET Analytic Configuration
GET Analytic Configuration
Face Recognition / People Analytics / People Counting
"NFV4-FR"
200
0
"bd72d9c54a9ea5d7"
GET Resource Statistics
GET Resource Statistics
Success