Endpoints

The REST endpoints are grouped by task area.

Image and Video

Live Stream Processing

• add_stream - Register a stream and its monitoring configuration.
• monitor_stream - Start monitoring a stream.
• stop_monitoring - Stop monitoring a stream.
• remove_stream - Remove a previously added stream.
• get_video_frame - Get the latest frame for a stream.

Video File Processing

• process_video - Submit a video-processing job.
• stop_video - Stop one video-processing job or all active video-processing jobs.
• get_video_status - Get status for one video-processing job.

Image Processing

• process_image - Process one base64-encoded image.

Search

Live Search

• 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.

Archive Search

• archive_search - Search archived detections and recordings.

Face Recognition

Group Management

• facerec_groups - List face recognition groups.
• facerec_add_group - Create a face recognition group.
• facerec_remove_group - Remove a face recognition group.
• facerec_search_group_names - Search face recognition group names.

Person Management

• 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_person_details - Get details for one face recognition person profile.
• facerec_search_people_names - Search face recognition person names.

Status

• 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.
• is_eoi_alive - Check whether the EyesOnIt API process is running.

License

• is_license_valid - Check whether a license is entered and valid.
• get_license_status - Get current license status and permission flags.
• validate_license - Validate and store a license key/token pair.

Config

• get_config - Read current runtime configuration.
• update_config - Update runtime configuration on the EyesOnIt server.
• get_supported_classes - List object classes supported by the bounding-box model.