Skip to main content
GET
/
rtstream
/
{stream_id}
/
index
/
{scene_index_id}
Get RTStream scene index details
curl --request GET \
  --url https://api.videodb.io/rtstream/{stream_id}/index/{scene_index_id} \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "rtstream_index_id": "scene-idx-12345",
    "extraction_type": "time",
    "extraction_config": {},
    "status": "running",
    "prompt": "<string>",
    "name": "<string>"
  }
}

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.

Retrieve detailed information about a specific scene index on a real-time stream.
  • Returns full index configuration including extraction type, config, prompt, and status

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

Scene index details

​
success
boolean
Example:

true

​
data
object