Skip to main content
PATCH
cURL

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
deprecated

DEPRECATED and ignored: backups are system-managed for every KB; this flag gates nothing. Accepted for old clients, never applied.

backup_retention_days
integer<int32> | null
deprecated

DEPRECATED and ignored: snapshot retention is system-managed (keep-last-N). Accepted for old clients, never applied.

backup_s3_bucket
string | null
backup_s3_key_prefix
string | null
backup_schedule_cron
string | null
deprecated

DEPRECATED and ignored: superseded by backup_window_utc_hour. Accepted for old clients, never applied.

backup_window_utc_hour
integer<int32> | null

UTC hour (0–23) when this KB's fixed daily backup may run. Set null to reset to the fleet default (01:00 UTC).

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
deprecated

DEPRECATED: backups are system-managed for every KB (idle teardown + daily window pass); this flag gates nothing. Still returned for existing clients; PATCH ignores it.

created_at
string<date-time>
required
data_size_bytes
integer<int64>
required
Required range: x >= 0
governance_mode
enum<string>
required

Query-time governance mode. Toggle via PUT …/k2/{kb_id}/policies/governance-mode (k2.policies.manage).

Available options:
off,
shadow,
enforce
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
deprecated

DEPRECATED: never had a cron behind it; superseded by backup_window_utc_hour. Still returned for existing clients; PATCH ignores it.

backup_window_utc_hour
integer<int32> | null

UTC hour (0–23) of this KB's daily backup window; null = fleet default (01:00 UTC). The daily cadence itself is fixed.

description
string | null