v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Workspace

Rename a document

DB-only rename — re-slugs the basename from name while preserving the directory prefix and extension; the document id is stable. A collision with another live document at the derived path → 409 DOCUMENT_PATH_TAKEN.

patch/workspaces/{workspaceId}/documents/{documentId}

Request body

namestring required

Response

The renamed document summary.

object'document' required
idstring uuid required
documentIdstring uuid required

Legacy alias of id — kept for pre-restructure consumers.

filenamestring required

Last segment of the VFS path — the user-facing filename.

vfsPathstring required
kindstring required
statusstring required
createdAtstring date-time required
updatedAtstring date-time required