v1

latestOpenAPI 3.1.02026-07-267154122.0 KB

Workspace

Legacy alias: rename a document (use PATCH .../documents/{documentId})

Deprecated alias for PATCH /workspaces/{workspaceId}/documents/{documentId} — identical body and responses.

post/workspaces/{workspaceId}/documents/{documentId}/rename

Headers

Idempotency-Keystring

Transport-level replay protection — any v2 POST may send it (1–255 printable ASCII characters; UUIDs recommended). The first response for a key is recorded and replayed verbatim for retries with the same key + method/path/body for 24 hours; replayed responses carry the Idempotency-Replay: true response header. Reusing a key with a different request — or retrying while the original is still in flight — returns 409 IDEMPOTENCY_ERROR. 5xx responses are never recorded (the retry re-executes).

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