Event
Real-time Event (Subscription)
This connection provides real-time notifications for events detected by the AI using WebSocket. The events contain information about the detected objects and their associated confidence scores. Once connected, the WebSocket will send real-time events as they occur.
Note: Please check the Authentication to get the service_id
and token
Endpoint:
Response Fields
detected_objects
Event History
The Event History API allows users to query past events detected by the AI detection system for a specific task. Users can filter the events based on a time range and event name, enabling them to analyze and review historical data efficiently.
Endpoint: GET /events/history
Payload:
Example Request:
Response
The response will be a JSON object containing an array of events that match the specified filters. Each event object will include the following information:
Example
#Response Fields
#detected_objects
Event Detail
This API retrieves detailed information about a specific event, including the event name, event description.
Endpoint: GET /events/types/:event_id
Parameters:
Example Request:
Response:
Response Fields:
Last updated