v2

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-07132063.9 KB

KnowledgeBases

Update a Knowledge Base

Partially update a Knowledge Base. Only the fields provided in the request body will be updated.

patch/v2/ControlPlane/KnowledgeBases/{kbId}

Headers

If-Matchstring

Example:"eyJpZCI6ImFuX2lkIiwidiI6MX0"

Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.

Request body

displayNamestring

Provides a unique and addressable name to be assigned to this Knowledge Base. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.

descriptionstring

A human readable description of this resource, up to 128 characters.

Example request

{
  "displayName": "product-docs",
  "description": "Product documentation knowledge base for customer support"
}

Response

Knowledge Base update request accepted.

messagestring

statusUrlstring

URI to check operation status.

Example response

{
  "message": "Knowledge Base update request accepted for processing."
}