Knowledge base

Update a knowledge base (name + description)

View as Markdown

Updates the metadata of a knowledge base. Note: the platform uses POST (not PATCH) on this path — preserved here as-is.

Only name and description are mutable through this endpoint. To add or remove content (files, URLs, text snippets), use the items endpoints.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

24-char hex ObjectId of the knowledge base.

Request

This endpoint expects an object.
namestringRequired1-40 characters

Display name. 1–40 characters; trimmed server-side.

descriptionstringOptional

Optional free-text description shown in the dashboard.

Response

Knowledge base updated.
statusboolean

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error