Skip to main content
POST
Search the whole workspace knowledge base

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required
Example:

"What is the price of the Peugeot 3008?"

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

5

table_uuids
string<uuid>[]
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.

tables
object[]

Schema of every table the matches came from. Matches can span tables here, so each row names its table instead of there being one shared header row.

rows
object[]

The matched records as table rows, best match first, keyed by column name. Use table_uuid to pick the matching schema from tables. 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 every table. next_page_url points at this same POST endpoint — resend the body with it.