Skip to main content
PATCH
Update knowledge base document

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Knowledge base ID

docId
string<uuid>
required

Document ID

Body

application/json
name
string

New document name (trimmed, max 120 characters).

Maximum string length: 120
text
string

New document content as plain text, max 200KB (UTF-8). Triggers re-indexing: status returns to pending until the new content is chunked and embedded.

Response

Document updated. status is only present after a content change and is always pending.

success
boolean
Example:

true

id
string<uuid>
name
string
status
enum<string>

Present only when text was sent. The document is being re-indexed.

Available options:
pending
Last modified on September 7, 2026