Skip to main content
POST
Find passages or files with combined ranking

Authorizations

Authorization
string
header
required

Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.

Body

application/json
mode
enum<string>
required

Return ranked passages or distinct files with full text.

Available options:
passages,
files
query
string
required

What you are looking for. A few words or a whole question both work.

Example:

"What is the refund policy?"

limit
integer
default:10

Maximum passages in passages mode, or distinct files in files mode. Defaults to 10.

Required range: 1 <= x <= 500
includeSources
boolean
default:true

Include external records connected to each matched file as sources. The file reference is always present. Defaults to true.

expandQuery
boolean
default:true

Also search query rewrites. Defaults to true.

Response

Matching passages or full files, best match first. One page; there is no next.

object
enum<string>
required

Type discriminator. Always list.

Available options:
list
url
string
required

The search this page came from.

Example:

"/v1/search/hybrid"

hasMore
boolean
required

Always false. A search answers the best matches in one page and has no next page.

Example:

false

nextCursor
string | null
required

Always null. A search has no position to resume from, so there is no cursor to pass back.

Example:

null

data
object[]
required

Matching passages or full files, best match first.