Skip to main content
PATCH
Update Knowledge Base
Changes state - verify before retry
v1 only. Knowledge bases are available on the /v1 API. There is no legacy unversioned equivalent.
Update a knowledge base. Today this changes its name. The new name must be unique within your workspace.

When to use this

  • Renaming: keep knowledge base names aligned with the product line or customer they cover as those names change on your side.
  • Naming conventions: bring older knowledge bases in line with a naming scheme so pickers stay readable.
Renaming does not affect the agents that reference the knowledge base; they keep working with the same id. A 400 Bad Request means the new name is invalid or already taken. See Errors for the standard error format.
Fetch the same kb_ ID after the update and confirm the name changed. If the request timed out, read the resource before retrying.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
name
string

Name of the knowledge base

Example:

"Updated Product Documentation"

Response

Knowledge base updated successfully.

id
string
required

Signed knowledge base ID.

Example:

"kb_abc123"

name
string
required
Maximum string length: 150
Example:

"Loan FAQ"

created_at
string<date-time>
updated_at
string<date-time>