Skip to main content
PATCH
/
rtstream
/
{stream_id}
/
index
/
scene
/
{scene_index_id}
/
status
Update RTStream scene index status
curl --request PATCH \
  --url https://api.videodb.io/rtstream/{stream_id}/index/scene/{scene_index_id}/status \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "action": "stop"
}
'
{
  "success": true,
  "message": "Operation successful"
}
Start or stop a scene index on a real-time stream.
  • action must be start or stop
  • Stopping an index pauses scene description generation but retains existing records

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"

Body

application/json
​
action
enum<string>
required
Available options:
start,
stop
Example:

"stop"

Response

200 - application/json

Scene index status updated

​
success
boolean
Example:

true

​
message
string
Example:

"Operation successful"