v5

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-0112516159.5 KB

Create video index

post/video/{video_id}/index/

Path parameters

video_idstring required

Example:m-12345

Request body

index_type'spoken_word' | 'scene'

enginestring

forceboolean

language_codestring

segmentation_typestring

callback_urlstring

Example request

{
  "index_type": "spoken_word",
  "engine": "default",
  "language_code": "en-US",
  "segmentation_type": "sentence",
  "callback_url": "https://webhook.example.com/callback"
}

Response

Index job started

successboolean

status'processing' | 'done' | 'failed'

Example response

{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}