Skip to main content
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"
}
'
{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}

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.

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.")
  • 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

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
video_id
string
required
Pattern: ^m-
Example:

"m-12345"

Body

application/json
​
index_type
enum<string>
default:spoken_word
Available options:
spoken_word,
scene
Example:

"spoken_word"

​
engine
string
default:default
Example:

"default"

​
force
boolean
Example:

false

​
language_code
string
Example:

"en-US"

​
segmentation_type
string
default:sentence
Example:

"sentence"

​
callback_url
string
Example:

"https://webhook.example.com/callback"

Response

200 - application/json

Index job started

​
success
boolean
Example:

true

​
status
enum<string>
Available options:
processing,
done,
failed
Example:

"processing"

​
data
object