Skip to main content
POST
Search within collection

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

collection_id
string
required
Example:

"default"

Body

application/json
query
string
required
Example:

"search query"

index_type
enum<string>
Available options:
spoken_word,
scene
Example:

"spoken_word"

search_type
enum<string>
Available options:
semantic,
custom
Example:

"semantic"

score_threshold
number
Example:

0.2

result_threshold
integer
Example:

10

stitch
boolean
Example:

true

rerank
boolean
Example:

false

filter
object[]

Response

200 - application/json

Search results

success
boolean
Example:

true

data
object