k2

Get knowledge base details

get/orgs/{org_id}/k2/{kb_id}

Path parameters

org_idstring required
kb_idstring required

Response

Knowledge base details

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

Changed in 7 of the 51 revisions of this API.216

    • added the optional property to the response with the status

      response-optional-property-added

    • response property backup_enabled deprecated

      response-property-deprecated

    • response property backup_schedule_cron deprecated

      response-property-deprecated

    • removed the required property from the response with the status

      response-required-property-removed

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property to the response with the status

      response-required-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the required property to the response with the status

      response-required-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 238 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog