Skip to main content
PUT
update knowledge document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier of the knowledge document

Body

application/json

Rename the document. Only filename is editable; the stored file and its extracted chunks are unchanged. Chunk settings can only be set at upload, so a non-null chunkSize or chunkOverlap returns 400.

filename
string

New filename for the document

Response

Successfully updated document

A single file uploaded into a knowledge group. Retrieved chunks reference it by ID.

id
string<uuid>

Unique identifier for the document.

knowledgeFolderId
string<uuid>

ID of the knowledge group this document belongs to.

filename
string

Original filename as uploaded.

fileType
string

MIME type or extension-derived file type.

fileSize
integer

Size of the file in bytes.

fileUrl
string<uri>

Internal URL at which the file is stored.

status
enum<string>

Current processing state. Only READY documents are searchable.

Available options:
UPLOADED,
PROCESSING,
READY,
FAILED
errorMessage
string | null

Failure reason when status is FAILED, otherwise null.

chunkSize
integer | null

Chunk size override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkOverlap is set, a null chunkSize means the default of 350.

chunkOverlap
integer | null

Chunk overlap override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkSize is set, a null chunkOverlap means the default of 0.

appliedChunking
object | null

Settings the last successful processing used. Null until the document has been processed.

createdAt
string<date-time>

Timestamp when the document was uploaded.

updatedAt
string<date-time> | null

Timestamp when the document record was last updated.