PATCH

Update Knowledge Base

Updates the name or description of an existing knowledge base.

PATCHhttps://api.vantaxai.com/v1/knowledge-bases/{knowledgebase_id}

Only include the fields you want to change. To change the content of a knowledge base, add or remove sources rather than updating it here.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

knowledgebase_idstringrequired
The knowledge base to update.
example: kb_71ac0

Body Parameters

namestringoptional
New display name.
descriptionstringoptional
Updated description.

Request

curl -X PATCH https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/knowledge-bases/{knowledgebase_id}
const result = await vantax.request("PATCH", "/v1/knowledge-bases/{knowledgebase_id}", {
  "name": "string",
  "description": "string"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/knowledge-bases/{knowledgebase_id}
result = vantax.request("PATCH", "/v1/knowledge-bases/{knowledgebase_id}", json={"name": "string", "description": "string"})

Response

{
  "success": true,
  "message": "Knowledge base updated successfully",
  "data": {
    "id": "kb_71ac0",
    "name": "Clinic FAQ (2026)",
    "description": "Front-desk answers about hours, insurance, and booking",
    "sub_account_id": "sub_8a1f4c2e",
    "source_count": 12,
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{ "success": false, "message": "Knowledge base not found" }

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "name", "message": "name must be a string" }
  ]
}