Sign in

v4

latestOpenAPI 3.1.02026-08-086635375.7 KB
Knowledge

update knowledge document

Update a document (rename)

put/v1/knowledge/documents/{id}

Path parameters

idstring required

Unique identifier of the knowledge document

Request body

filenamestring

New filename for the document

Response

Successfully updated document

idstring uuid

Unique identifier for the document.

knowledgeFolderIdstring uuid

ID of the knowledge group this document belongs to.

filenamestring

Original filename as uploaded.

fileTypestring

MIME type or extension-derived file type.

fileSizeinteger

Size of the file in bytes.

fileUrlstring uri

Internal URL at which the file is stored.

status'UPLOADED' | 'PROCESSING' | 'READY' | 'FAILED'

Current processing state. Only READY documents are searchable.

errorMessagestring nullable

Failure reason when status is FAILED, otherwise null.

createdAtstring date-time

Timestamp when the document was uploaded.

updatedAtstring date-time nullable

Timestamp when the document record was last updated.