Create video index
curl --request POST \
--url https://api.videodb.io/video/{video_id}/index/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
}
'const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
index_type: 'spoken_word',
engine: 'default',
force: false,
language_code: 'en-US',
segmentation_type: 'sentence',
callback_url: 'https://webhook.example.com/callback'
})
};
fetch('https://api.videodb.io/video/{video_id}/index/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'index_type' => 'spoken_word',
'engine' => 'default',
'force' => false,
'language_code' => 'en-US',
'segmentation_type' => 'sentence',
'callback_url' => 'https://webhook.example.com/callback'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.videodb.io/video/{video_id}/index/"
payload := strings.NewReader("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.videodb.io/video/{video_id}/index/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videodb.io/video/{video_id}/index/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/video/{video_id}/index/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
}'import Foundation
let parameters = [
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api.videodb.io/video/{video_id}/index/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"x-access-token": "<api-key>",
"Content-Type": "application/json"
]
request.httpBody = postData
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/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);using RestSharp;
var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
index_type: 'spoken_word',
engine: 'default',
force: false,
language_code: 'en-US',
segmentation_type: 'sentence',
callback_url: 'https://webhook.example.com/callback'
})
};
fetch('https://api.videodb.io/video/{video_id}/index/', 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, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
val request = Request.Builder()
.url("https://api.videodb.io/video/{video_id}/index/")
.post(body)
.addHeader("x-access-token", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"success": true,
"status": "processing",
"data": {
"id": "job-123",
"output_url": "https://api.videodb.io/async-response/job-123"
}
}Create Spoken Word Index
Create a semantic search index from video transcription
POST
/
video
/
{video_id}
/
index
/
Create video index
curl --request POST \
--url https://api.videodb.io/video/{video_id}/index/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
}
'const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
index_type: 'spoken_word',
engine: 'default',
force: false,
language_code: 'en-US',
segmentation_type: 'sentence',
callback_url: 'https://webhook.example.com/callback'
})
};
fetch('https://api.videodb.io/video/{video_id}/index/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'index_type' => 'spoken_word',
'engine' => 'default',
'force' => false,
'language_code' => 'en-US',
'segmentation_type' => 'sentence',
'callback_url' => 'https://webhook.example.com/callback'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.videodb.io/video/{video_id}/index/"
payload := strings.NewReader("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.videodb.io/video/{video_id}/index/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videodb.io/video/{video_id}/index/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/video/{video_id}/index/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
}'import Foundation
let parameters = [
"index_type": "spoken_word",
"engine": "default",
"force": false,
"language_code": "en-US",
"segmentation_type": "sentence",
"callback_url": "https://webhook.example.com/callback"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api.videodb.io/video/{video_id}/index/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"x-access-token": "<api-key>",
"Content-Type": "application/json"
]
request.httpBody = postData
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/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);using RestSharp;
var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/index/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
index_type: 'spoken_word',
engine: 'default',
force: false,
language_code: 'en-US',
segmentation_type: 'sentence',
callback_url: 'https://webhook.example.com/callback'
})
};
fetch('https://api.videodb.io/video/{video_id}/index/', 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, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/index/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"index_type\": \"spoken_word\",\n \"engine\": \"default\",\n \"force\": false,\n \"language_code\": \"en-US\",\n \"segmentation_type\": \"sentence\",\n \"callback_url\": \"https://webhook.example.com/callback\"\n}")
val request = Request.Builder()
.url("https://api.videodb.io/video/{video_id}/index/")
.post(body)
.addHeader("x-access-token", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"success": true,
"status": "processing",
"data": {
"id": "job-123",
"output_url": "https://api.videodb.io/async-response/job-123"
}
}Create a semantic search index for spoken words in the video, enabling intelligent search across video transcripts.
import videodb
conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()
video = coll.get_videos()[0]
# Index spoken words for semantic search
video.index_spoken_words()
print("Indexing complete. Video is now searchable.")
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];
// Index spoken words for semantic search
await video.indexSpokenWords();
console.log('Indexing complete. Video is now searchable.');
- Automatically generates transcript if not already created
- Creates semantic embeddings for all spoken words
- Enables powerful search capabilities on video content
- Indexing is asynchronous; progress can be tracked with callbacks
- Index remains in place even if video storage is deleted
- Use language_code parameter for non-English videos (optional)
Authorizations
API key for authentication (sk-xxx format)
Path Parameters
Pattern:
^m-Example:
"m-12345"
Body
application/json
Available options:
spoken_word, scene Example:
"spoken_word"
Example:
"default"
Example:
false
Example:
"en-US"
Example:
"sentence"
Example:
"https://webhook.example.com/callback"
⌘I