Skip to main content
POST
Search inside a single knowledge table

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid
string<uuid>
required

Body

application/json
query
string
required
Example:

"What is the price of the Peugeot 3008?"

limit
integer
Required range: 1 <= x <= 20
Example:

5

min_score
number<float>
Required range: 0 <= x <= 1
Example:

0.35

page
integer

Page of the matched rows

Required range: x >= 1
Example:

1

per_page
integer

Matched rows per page

Required range: 1 <= x <= 100
Example:

15

Response

Search results

success
boolean
Example:

true

message
string
Example:

"Search completed"

data
object

The excerpt view: the text chunks that matched.

fields
object[]

The table's columns in schema order — same shape as the records listing, so matches can be rendered in the same grid.

rows
object[]

The matched records as table rows, best match first, keyed by column name. A record that produced several matching chunks appears once, scored by its best chunk. Records deleted since the last index are omitted.

pagination
object

Page state over the matched rows. Search returns a ranked top-N (see limit), so this pages that result set rather than the whole table. next_page_url points at this same POST endpoint — resend the body with it.