Skip to main content
POST
/
index
/
{index_name}
/
search
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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