Skip to main content
POST
/
index
/
{index_name}
/
search
Search Videos
curl --request POST \
  --url https://api.example.com/index/{index_name}/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "asset_ids": [
    "<string>"
  ],
  "top_k": 30,
  "top_p": 0,
  "modes": [
    "video",
    "image"
  ],
  "use_masks": false,
  "use_boxes": false,
  "queue_job": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.askvideos.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
index_name
string
required

Body

application/json
​
query
string
required

The search query

​
asset_ids
string[] | null

Video IDs or Image IDs to include in search

​
top_k
integer
default:30

Number of segments to return

​
top_p
number
default:0

Threshold for search

​
modes
string[]

Modalities to search over

​
use_masks
boolean | null
default:false

Whether to use masks or not.

​
use_boxes
boolean | null
default:false

Whether to use boxes or not.

​
queue_job
boolean | null
default:false

Whether to queue the job

Response

Successful Response