k2

Changed on

Update a knowledge base.

patch/orgs/{org_id}/k2/{kb_id}

Request

  • Base URL
    https://api.timbal.ai
  • URL
    https://api.timbal.ai/orgs/{org_id}/k2/{kb_id}
  • Auth
    HTTP bearer

Path parameters

org_idstring required
kb_idstring required

Request body

auto_processing_enabledboolean nullable

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_enabledboolean nullable

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

backup_retention_daysinteger nullable

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

backup_s3_bucketstring nullable
backup_s3_key_prefixstring nullable
backup_schedule_cronstring nullable

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

backup_window_utc_hourinteger nullable

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

descriptionstring nullable
namestring nullable

Response

Updated knowledge base

auto_processing_enabledboolean required

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

backup_enabledboolean required

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.

backup_last_completed_atstring date-time nullable
backup_last_errorstring nullable
backup_last_started_atstring date-time nullable
backup_last_statusstring nullable
backup_retention_daysinteger nullable
backup_s3_bucketstring nullable
backup_s3_key_prefixstring nullable
backup_schedule_cronstring nullable

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

backup_window_utc_hourinteger nullable

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

created_atstring date-time required
data_size_bytesinteger required
descriptionstring nullable
governance_mode'off' | 'shadow' | 'enforce' required

Per-KB query governance mode.

idinteger required
index_countinteger required
namestring required
row_countinteger required
table_countinteger required
uidstring required
updated_atstring date-time required
vector_countinteger required

Changes

  • 33e77c7fd113Revision changes
    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      added the optional property to the response with the status

    • info

      response property backup_enabled deprecated

    • info

      response property backup_schedule_cron deprecated

  • e1c81d0f4235Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status