Search within video

post/video/{video_id}/search/

Request

Base URL
https://api.videodb.io
Auth
API key in header x-access-token
TypeScript
https://skmtc.dev/video-db/apis/videodb-server-api/docs/video/:video_id/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

video_idstring required

Example:m-12345

Request body

querystring required

index_type'spoken_word' | 'scene'

search_type'semantic' | 'keyword'

score_thresholdnumber

result_thresholdinteger

stitchboolean

scene_index_idstring

filterobject[]

Example request

{
  "query": "search query",
  "index_type": "spoken_word",
  "search_type": "semantic",
  "score_threshold": 0.2,
  "result_threshold": 10,
  "stitch": true,
  "scene_index_id": "idx-12345"
}

Response

Search results

successboolean

Example response

{
  "success": true,
  "data": {
    "query": "search query",
    "results": [
      {
        "video_id": "m-12345",
        "start": 10.5,
        "end": 20.3,
        "text": "matched content",
        "score": 0.95
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.