Skip to main content
POST
/
rtstream
/
event
Create collection event
curl --request POST \
  --url https://api.videodb.io/rtstream/event \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "event_prompt": "Detect when a person enters the room",
  "label": "person-entry"
}
'
{
  "success": true,
  "data": {
    "event_id": "event-12345"
  }
}

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.

Create a detection event that defines what to look for in real-time streams. Events are reusable templates that can be attached to stream indexes as alerts.
  • event_prompt describes the condition to detect in natural language
  • label is a short identifier for the event type
  • Events are reusable across multiple stream indexes and alerts

Create Alert

Attach event to a stream index

Event Detection Guide

Learn about event detection

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Body

application/json
​
event_prompt
string
required
Example:

"Detect when a person enters the room"

​
label
string
required
Example:

"person-entry"

Response

200 - application/json

Event created

​
success
boolean
Example:

true

​
data
object