Skip to main content
GET
Get video index status
Retrieve metadata and status of a video index.
This is a supported legacy singular /video/.../index endpoint. For current work, use Understand → video.index(), then video.get_index(), video.list_indexes(), or video.delete_index().
  • index_type is required and can be spoken_word or scene
  • Returns index metadata and status for the requested type
  • Requires index to be created first with create-index endpoint
  • engine is optional and defaults to default

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"