Skip to main content
POST
Search indexed content

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Body

application/json
query
string
required
Minimum string length: 1
queries
string[]
Maximum array length: 3
Minimum string length: 1
queryMode
enum<string>
default:auto
Available options:
none,
auto
limit
integer
default:10
Required range: 1 <= x <= 50
collectionId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
fullTextWeight
number
default:0.3
Required range: 0 <= x <= 1
semanticWeight
number
default:0.7
Required range: 0 <= x <= 1
rrfK
integer
default:60
Required range: 1 <= x <= 1000

Response

Successful response

query
string
required
queryMode
enum<string>
required
Available options:
none,
auto
executedQueries
string[]
required
scoring
object
required
results
object[]
required
count
integer
required
Required range: 0 <= x <= 9007199254740991