TransferDocuments

POST /v1/workspaces/{id}/transfer - move a document (and its explore subtree) into another workspace in the same store, preserving document ids.

Type object

Shape

Field	Type	Description
targetrequired	WorkspaceId
rootrequired	DocumentId	DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
parent	DocumentId or null	Default `null`
index	integer (uint, >= 0)	Entry index among siblings under `parent`. Past the end means append. Default `0`

Example

{
  "target": "00000000-0000-4000-8000-000000000000",
  "root": "00000000-0000-4000-8000-000000000000",
  "parent": "00000000-0000-4000-8000-000000000000",
  "index": 0
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

POST/v1/workspaces/{id}/transfer
Move a document and its explore subtree into another workspace

Generated from contract version 1. Last updated November 12, 2026.