Skip to main content
POST
Search for similar chunks

Authorizations

X-API-Key
string
header
required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization
string | null
X-API-Key
string | null

Body

application/json

Request schema for searching similar chunks.

query
string
required

Search query text

limit
integer
default:5

Maximum number of results

Required range: 1 <= x <= 50
document_uuids
string[] | null

Filter by specific document UUIDs

min_similarity
number | null

Minimum similarity threshold

Required range: 0 <= x <= 1

Response

Successful Response

Response schema for chunk search results.

chunks
ChunkResponseSchema · object[]
required
query
string
required
total_results
integer
required