Sign in

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"
  }
}

Changes

Changed in 2 of the 5 revisions of this API.2

  • fd78812f318f1See the full diff
    • ○

      the engine request property default value changed from AAI to default

      request-property-default-value-changed

  • 7d19a3906d5b1See the full diff
    • ○

      the engine request property default value changed from default to AAI

      request-property-default-value-changed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog