Skip to main content
GET
/
video
/
{video_id}
/
index
Get video index status
curl --request GET \
  --url https://api.videodb.io/video/{video_id}/index/ \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "status": "done",
  "message": "Index is available"
}

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 metadata and status of the spoken word index for a video. 
import videodb

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

# The spoken word index is automatically created when indexing
# Access it through search operations
results = video.search("example query")

print(f"Index is active and searchable")
print(f"Found {len(results.docs)} results for the query")
  • Returns index metadata for spoken word semantic search
  • Use search() method to perform actual searches on the index
  • Requires index to be created first with create-index endpoint
  • Returns index status and configuration
  • Only index type currently supported is spoken_word

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"

Query Parameters

​
index_type
enum<string>
required
Available options:
spoken_word,
scene
Example:

"spoken_word"

​
engine
string
default:default
Example:

"default"

Response

200 - application/json

Index status

​
success
boolean
Example:

true

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

"done"

​
message
string
Example:

"Index is available"