Skip to main content
GET
/
rtstream
/
{stream_id}
/
index
/
{scene_index_id}
/
alert
List RTStream alerts
curl --request GET \
  --url https://api.videodb.io/rtstream/{stream_id}/index/{scene_index_id}/alert \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "alerts": [
      {
        "alert_id": "alert-12345",
        "event_id": "event-12345",
        "prompt": "Detect when a person enters the room",
        "label": "person-entry",
        "callback_url": "https://webhook.example.com/alert",
        "status": "enabled"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.videodb.io/llms.txt

Use this file to discover all available pages before exploring further.

List all alerts configured on a specific scene index of a real-time stream.
  • Returns all alerts with their event details, callback URLs, and status
  • Alert status is either enabled or disabled

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
stream_id
string
required
Example:

"rts-12345"

​
scene_index_id
string
required
Example:

"scene-idx-12345"

Response

200 - application/json

List of alerts

​
success
boolean
Example:

true

​
data
object