REST Endpoints

The endpoints supported by the REST API are outlined below, including the path, REST method, inputs, and outputs for each method call.

add_stream - This method allows you to add a stream to EyesOnIt which you can then monitor

remove_stream - This method removes a stream from EyesOnIt which was previously added with the add_stream endpoint.

monitor_stream - This endpoint monitors a stream which was previously added to EyesOnIt with the add_stream endpoint.

stop_monitoring - This endpoint stops monitoring of a stream which was previously added to EyesOnIt and monitored with the add_stream and monitor_stream endpoints.

get_all_streams_info - This method gets summary information about all streams that are currently added to EyesOnIt.

get_stream_details - This method gets detailed information about a single stream that has been added to EyesOnIt.

get_video_frame - This endpoint gets a video frame from an RTSP URL.

get_last_detection_info - This method gets information about the last detection for the specified stream.

get_supported_classes - This method gets the bounding box classes supported for common object detection.

is_eoi_alive - This method gets the bounding box classes supported for common object detection.

is_license_valid - This method gets the bounding box classes supported for common object detection.

validate_license - This method gets the bounding box classes supported for common object detection.

process_image - This method uses the EyeOnIt Large Vision Model to process a single base64-encoded image.