Skip to main content
GET
/
video
/
{video_id}
/
index
/
scene
/
{scene_index_id}
Get scene index details
curl --request GET \
  --url https://api.videodb.io/video/{video_id}/index/scene/{scene_index_id} \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "id": "scene-idx-12345",
    "video_id": "m-12345",
    "scene_type": "shot",
    "status": "done",
    "scenes": [
      {
        "start_time": 10.5,
        "end_time": 25.3,
        "confidence": 0.85
      }
    ]
  }
}

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 all scene records from a specific scene index including descriptions and visual embeddings. 
import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()
video = coll.get_videos()[0]

# Get scene index records
scene_records = video.get_scene_index("scene_index_id")

for record in scene_records:
    print(f"Scene: {record['scene_id']}")
    print(f"Description: {record['description']}")
    print(f"Time: {record['start']}s - {record['end']}s")
  • Returns list of scene records with AI-generated descriptions
  • Each record includes start/end timestamps and visual embeddings
  • Scene IDs follow the pattern sc- prefix
  • Can be used to search for specific scenes by description
  • Useful for creating visual navigation interfaces

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
video_id
string
required
Pattern: ^m-
Example:

"m-12345"

​
scene_index_id
string
required
Example:

"scene-idx-12345"

Response

200 - application/json

Scene index details

​
success
boolean
Example:

true

​
data
object