This section summarizes the response payloads returned by the REST API.
All endpoints return success, message, and data.
Image and Video
| Endpoint | data Shape |
|---|
POST /process_image | detections, image |
POST /add_stream | usually null |
POST /process_video | video_id |
POST /remove_stream | usually null |
POST /get_video_frame | image |
Search
| Endpoint | data Shape |
|---|
POST /archive_search | results |
POST /live_search | search_id |
POST /pause_live_search | usually null |
POST /resume_live_search | usually null |
POST /cancel_live_search | usually null |
Face Recognition
| Endpoint | data Shape |
|---|
GET /facerec_groups | groups |
POST /facerec_add_group | usually null |
POST /facerec_remove_group | group_id, removed_memberships |
POST /facerec_add_person | usually null |
POST /facerec_add_people | usually null |
POST /facerec_remove_person | usually null |
POST /facerec_search_group_names | matches |
POST /facerec_search_people_names | matches |
POST /facerec_person_details | person_id, person_name, groups, images |
Status
| Endpoint | data Shape |
|---|
POST /monitor_stream | usually null |
POST /stop_monitoring | usually null |
GET /get_all_streams_info | streams |
POST /get_stream_details | stream |
POST /get_last_detection_info | detections, image |
Config
| Endpoint | data Shape |
|---|
POST /update_config | usually null |