Skip to main content
POST
/
orgs
/
{org_id}
/
kbs
/
{kb_id}
/
tables
/
{table_name}
/
search
cURL
curl --request POST \
  --url https://dev.timbal.ai/orgs/{org_id}/kbs/{kb_id}/tables/{table_name}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "embedding_names": [
    "<string>"
  ],
  "fts_columns": [
    "<string>"
  ],
  "limit": 10,
  "offset": 0,
  "query": "<string>",
  "select_columns": [
    "<string>"
  ],
  "where": "<string>"
}'
[
  {
    "id": 1,
    "name": "Alice Johnson",
    "email": "alice@example.com"
  },
  {
    "id": 2,
    "name": null,
    "email": "bob@example.com"
  },
  {
    "id": 3,
    "name": "Carol",
    "email": "carol@example.com"
  }
]

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
integer
required
​
kb_id
integer
required
​
table_name
string
required

Body

application/json
​
embedding_names
string[]
required

List of embedding names to use for semantic search. Only a single column is supported at the moment.

​
query
string
required

Semantic search query.

​
fts_columns
string[] | null

List of column names to use for full-text search. When specified together with embedding_names, search will be hybrid (both semantic and full-text).

​
limit
integer
default:10

Maximum number of results to return.

​
offset
integer
default:0

Number of results to skip before returning.

​
select_columns
string[] | null

List of column names to return in the search results. When not specified, all columns will be returned.

​
where
string | null

SQL WHERE expression to apply to the search. This feature is experimental and may be removed or changed in the future.

Response

200 - application/json

Array of records matching the search query. Structure depends on the table schema and selected columns.

The response is of type any[].