Skip to main content
PUT
Update a knowledge base

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Knowledge base id (kb_ prefixed).

Body

application/json
name
string

New display name (1-200 chars).

description
string

New free-form description (max 1000 chars).

config
object

Replacement key/value config map.

refresh_schedule
enum<string>

New refresh cadence for external-source documents.

Available options:
manual,
hourly,
daily,
weekly

Response

The updated knowledge base, in the standard { data, meta } envelope.

The updated knowledge base, in the standard { data, meta } envelope.