Skip to main content
POST
/
orgs
/
{org_id}
/
kbs
/
{kb_id}
/
indexes
cURL
curl --request POST \
  --url https://dev.timbal.ai/orgs/{org_id}/kbs/{kb_id}/indexes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "column_names": [
    "<string>"
  ],
  "is_unique": true,
  "name": "<string>",
  "table_name": "<string>",
  "type": "btree"
}
'

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<int64>
required
​
kb_id
integer<int64>
required

Body

application/json
​
column_names
string[]
required

List of column names to index. At least one column is required. Multiple columns will create a composite index

​
is_unique
boolean
required

Whether the index should enforce uniqueness

​
name
string
required

Index name. This must be unique in the entire Knowledge Base

​
table_name
string
required

Table name

​
type
enum<string>
required

Index type

Available options:
btree,
hash,
gin,
gist,
brin,
hnsw

Response

204

Index created successfully