Skip to main content
PATCH
/
orgs
/
{org_id}
/
k2
/
{kb_id}
cURL
curl --request PATCH \
  --url https://api.timbal.ai/orgs/{org_id}/k2/{kb_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_processing_enabled": true,
  "backup_enabled": true,
  "backup_retention_days": 123,
  "backup_s3_bucket": "<string>",
  "backup_s3_key_prefix": "<string>",
  "backup_schedule_cron": "<string>",
  "description": "<string>",
  "name": "<string>"
}
'
{
  "auto_processing_enabled": true,
  "backup_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "data_size_bytes": 1,
  "id": 123,
  "index_count": 1,
  "name": "<string>",
  "row_count": 1,
  "table_count": 1,
  "uid": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "vector_count": 1,
  "backup_last_completed_at": "2023-11-07T05:31:56Z",
  "backup_last_error": "<string>",
  "backup_last_started_at": "2023-11-07T05:31:56Z",
  "backup_last_status": "<string>",
  "backup_retention_days": 123,
  "backup_s3_bucket": "<string>",
  "backup_s3_key_prefix": "<string>",
  "backup_schedule_cron": "<string>",
  "description": "<string>"
}

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
string
required
​
kb_id
string
required

Body

application/json
​
auto_processing_enabled
boolean | null

Toggle the automatic parsing, chunking, and embedding pipeline for new file uploads. When false, uploads are stored as-is. Existing files are not affected.

​
backup_enabled
boolean | null
​
backup_retention_days
integer<int32> | null
​
backup_s3_bucket
string | null
​
backup_s3_key_prefix
string | null
​
backup_schedule_cron
string | null
​
description
string | null
​
name
string | null

Response

200 - application/json

Updated knowledge base

​
auto_processing_enabled
boolean
required

When false, file uploads to this knowledge base are stored as-is and skipped by the automatic parsing, chunking, and embedding pipeline.

​
backup_enabled
boolean
required
​
created_at
string<date-time>
required
​
data_size_bytes
integer<int64>
required
Required range: x >= 0
​
id
integer<int64>
required
​
index_count
integer<int64>
required
Required range: x >= 0
​
name
string
required
​
row_count
integer<int64>
required
Required range: x >= 0
​
table_count
integer<int64>
required
Required range: x >= 0
​
uid
string
required
​
updated_at
string<date-time>
required
​
vector_count
integer<int64>
required
Required range: x >= 0
​
backup_last_completed_at
string<date-time> | null
​
backup_last_error
string | null
​
backup_last_started_at
string<date-time> | null
​
backup_last_status
string | null
​
backup_retention_days
integer<int32> | null
​
backup_s3_bucket
string | null
​
backup_s3_key_prefix
string | null
​
backup_schedule_cron
string | null
​
description
string | null