List Scene Indexes - VideoDB Documentation

Get video scene index status

curl --request GET \
  --url https://api.videodb.io/video/{video_id}/index/scene/ \
  --header 'x-access-token: <api-key>'

const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://api.videodb.io/video/{video_id}/index/scene/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.videodb.io/video/{video_id}/index/scene/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/video/{video_id}/index/scene/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-access-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/video/{video_id}/index/scene/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

import Foundation

let url = URL(string: "https://api.videodb.io/video/{video_id}/index/scene/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-access-token": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/scene/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/scene/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://api.videodb.io/video/{video_id}/index/scene/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/scene/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/scene/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/index/scene/")
  .get()
  .addHeader("x-access-token", "<api-key>")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "status": "done",
  "data": {
    "scene_count": 25,
    "total_duration": 120.5,
    "last_updated": "2023-11-07T05:31:56Z"
  }
}

GET

video

{video_id}

index

scene

Get video scene index status

curl --request GET \
  --url https://api.videodb.io/video/{video_id}/index/scene/ \
  --header 'x-access-token: <api-key>'

const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://api.videodb.io/video/{video_id}/index/scene/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.videodb.io/video/{video_id}/index/scene/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/video/{video_id}/index/scene/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-access-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/video/{video_id}/index/scene/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

import Foundation

let url = URL(string: "https://api.videodb.io/video/{video_id}/index/scene/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-access-token": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/scene/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/scene/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://api.videodb.io/video/{video_id}/index/scene/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/scene/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/scene/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/index/scene/")
  .get()
  .addHeader("x-access-token", "<api-key>")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "status": "done",
  "data": {
    "scene_count": 25,
    "total_duration": 120.5,
    "last_updated": "2023-11-07T05:31:56Z"
  }
}

Retrieve all scene indexes created for a video.

This is a supported legacy singular /video/.../index endpoint. For current work, use Understand → video.index(), then get_index(), list_indexes(), or delete_index().

import videodb

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

# List all scene indexes
indexes = video.list_scene_index()

for index in indexes:
    print(f"Index ID: {index['scene_index_id']}")
    print(f"Name: {index.get('name', 'Unnamed')}")
    print(f"Status: {index.get('status')}")

import { connect } from 'videodb';

const conn = connect({ apiKey: 'your_api_key' });
const coll = await conn.getCollection();
const videos = await coll.getVideos();
const video = videos[0];

// List all scene indexes
const indexes = await video.listSceneIndex();

for (const index of indexes) {
  console.log(`Index ID: ${index.sceneIndexId}`);
  console.log(`Name: ${index.name || 'Unnamed'}`);
  console.log(`Status: ${index.status}`);
}

Returns all scene indexes associated with a video
Each index contains metadata including ID, name, and creation status
Scene indexes allow different indexing strategies for the same video
Use returned IDs to retrieve specific index details or delete indexes

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"

Response

200 - application/json

Scene index status

success

boolean

Example:

true

status

enum<string>

Available options:

done,

processing,

failed

Example:

"done"

data

object

Show child attributes