API v1
Knowledge
Knowledge CRUD

Update Knowledge Base

Updates a knowledge base. Only the fields you send change; send description null to clear it. agent_id cannot be changed.

patch/v1/knowledge/{kb_id}

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

kb_idstring required

Request body

namestring nullable

New KB name; omit to keep the current name

descriptionstring nullable

New KB description; omit to keep it, send null to clear it

Response

Successful Response

idstring required

KB unique identifier

namestring required

KB name specified by the user

descriptionstring nullable

KB description specified by the user

type'managed' | 'external' required
organization_idstring required

Organization ID

agent_idstring nullable

Agent ID

project_idstring nullable

The project the item belongs to; unset means the org's Default project on create.

total_documentsinteger

Total count of embedded documents

Changes

No recorded changes to this operation across all 4 revisions of this API.