The Platform API

Alerts

Manage your videos, ask questions, and build applications with the Platform API. Explore the operations below for request details, responses, and examples.

Alerts

Monitor and manage alerts generated during video analysis.

GET/api/v1/projects/:projectId/alertsList alerts

List alerts

Query params: limit, severity (critical/warning/info), status (active/acknowledged/resolved/dismissed), timeWindow, videoId

GET/api/v1/projects/:projectId/alerts/statsGet alert statistics

Get alert statistics

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/alerts/stats using your project key or user token.

POST/api/v1/projects/:projectId/alertsCreate manual alert

Create manual alert

{
  "title": "Suspicious activity detected",
  "description": "Person in restricted area at 14:32",
  "severity": "warning",
  "type": "security",
  "videoId": "VIDEO_ID"
}

POST/api/v1/projects/:projectId/alerts/:alertId/acknowledgeMark as acknowledged

Mark as acknowledged

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/alerts/:alertId/acknowledge using your project key or user token.

POST/api/v1/projects/:projectId/alerts/:alertId/resolveMark as resolved

Mark as resolved

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/alerts/:alertId/resolve using your project key or user token.

POST/api/v1/projects/:projectId/alerts/:alertId/dismissDismiss alert

Dismiss alert

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/alerts/:alertId/dismiss using your project key or user token.

GET/api/v1/projects/:projectId/alerts/streamSSE stream for real-time alerts

SSE stream for real-time alerts

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/alerts/stream using your project key or user token.