Create Version Snapshot
POST /api/writing/documents/{document_id}/versions/snapshot
POST
/api/writing/documents/{document_id}/versions/snapshot
Create a named version snapshot of the current document state.
Used by the Edit workspace to auto-save versions before each editing phase (e.g. “Pre-Developmental Edit”, “Pre-Line Edit”).
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” document_id
required
Document Id
string
Request Body required
Section titled “Request Body required ” VersionSnapshotRequest
Request to create a named version snapshot (used by Edit workspace).
object
changeDescription
required
Changedescription
string
Responses
Section titled “ Responses ”Successful Response
VersionSnapshotResponse
Response after creating a named version snapshot.
object
versionId
required
Versionid
string
versionNumber
required
Versionnumber
integer
changeDescription
required
Changedescription
string
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context