Knowledge Base

Update Knowledge Base Document

Update Document

Requires the OWNER or ADMIN role. Renames the document's title and/or description -- the only fields this endpoint can change, at any status. A title change also propagates to that document's stored chunk metadata so retrieval citations pick it up immediately.

patch/knowledge-bases/{kbId}/documents/{docId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/knowledge-bases/{kbId}/documents/{docId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

kbIdstring required

The collection's knowledgeBaseId.

docIdstring required

The document's documentId.

Request body

titlestring

Cannot be sent as an empty string.

descriptionstring

Response

OK

status'success'

Changes

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