Endpoints
The REST endpoints are grouped by the same task areas used in the TypeScript API reference.
Image and Video
- process_image - Process one base64-encoded image.
- add_stream - Register a stream and its monitoring configuration.
- process_video - Submit a video-processing job.
- remove_stream - Remove a previously added stream.
- get_video_frame - Get the latest frame for a stream.
Search
- archive_search - Search archived detections and recordings.
- live_search - Start a live search task.
- pause_live_search - Pause one live search or all live searches.
- resume_live_search - Resume one live search or all live searches.
- cancel_live_search - Cancel one live search or all live searches.
Face Recognition
- facerec_groups - List face recognition groups.
- facerec_add_group - Create a face recognition group.
- facerec_remove_group - Remove a face recognition group.
- facerec_add_person - Create a face recognition person profile.
- facerec_add_people - Bulk import face recognition people from a file.
- facerec_remove_person - Remove a face recognition person profile.
- facerec_search_group_names - Search face recognition group names.
- facerec_search_people_names - Search face recognition person names.
- facerec_person_details - Get details for one face recognition person profile.
Status
- monitor_stream - Start monitoring a stream.
- stop_monitoring - Stop monitoring a stream.
- get_all_streams_info - List all configured streams.
- get_stream_details - Get the full configuration and status for one stream.
- get_last_detection_info - Get the most recent detection payload for one stream.
Config
- update_config - Update runtime configuration on the EyesOnIt server.