Skip to content

Move Document

POST
/api/writing/documents/move

πŸ“„ Move document to folder.

Moves a document to a specified folder or to root (uncategorized).

Args: request: Move request with document_id and folder_id service: Injected DocumentCategoriesService instance

Returns: WritingDocumentMoveResponse: Move operation result with timestamp

Raises: HTTPException 400: If target folder not found HTTPException 500: If document move fails

DocumentMoveRequest
object
document_id
required
Document Id
string
folder_id
Any of:
string

Successful Response

WritingDocumentMoveResponse

Response model for document move operations in Writing Studio.

Confirms successful document move to a folder with operation metadata. Used for single document folder assignment operations.

Fields:

  • success: Whether the move operation succeeded
  • document_id: ID of the moved document
  • folder_id: Target folder ID (null for root/uncategorized)
  • timestamp: ISO 8601 timestamp of the operation

Usage: POST /api/creative/categories/documents/move returns this model.

JSON Example:

{
  "success": true,
  "documentId": "doc_abc123",
  "folderId": "folder_xyz",
  "timestamp": "2025-12-04T10:30:00Z"
}
object
success
required
Success

Move operation success status

boolean
documentId
required
Documentid

Moved document ID

string
folderId
Any of:
string
timestamp
required
Timestamp

Operation timestamp (ISO 8601)

string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object