VideoDB icon

VideoDB

Interact with the VideoDB API

Index Scenes

AI-generated

Summary

Indexes scenes of a video with configurable extraction method, model, and optional scene list.

Inputs

  • collection_id (required) — Choose from the list, or specify an ID using an expression
  • video_id (required) — The ID of the video
  • name — The name for the scene index
  • extraction_type — The method for scene extraction: Shot Based or Time Based (default: Shot Based)
  • extraction_config — Configuration for the scene extraction (JSON)
  • prompt — A prompt to guide the indexing
  • model_name — The name of the model to use for indexing
  • model_config — Configuration for the model (JSON)
  • scenes — A list of scenes to be indexed (JSON)
  • callback_url — Callback URL for completion

Output shape

API response body from POST /video/{video_id}/index/scene

Returns the created scene index details; exact shape not documented in source, handled by API.

Examples

Example 1: Index all scenes shot-based for a video

collection_id = collection_123, video_id = video_456, extraction_type = shot

Discussion