Compare Forks
GET /api/writing/documents/{document_id}/forks/compare
GET
/api/writing/documents/{document_id}/forks/compare
Compare two branches, or Main vs a branch. Omit fork1 or fork2 to compare against Main.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” document_id
required
Document Id
string
Query Parameters
Section titled “Query Parameters ”Responses
Section titled “ Responses ”Successful Response
ForkComparisonResponse
Response for comparing two fork branches (or Main vs a branch).
object
fork1Label
required
Fork1Label
string
fork2Label
required
Fork2Label
string
fork1WordCount
required
Fork1Wordcount
integer
fork2WordCount
required
Fork2Wordcount
integer
statistics
required
VersionComparisonStats
Statistics for a version comparison.
object
additions
Additions
integer
deletions
Deletions
integer
wordCountChange
Wordcountchange
integer
characterCountChange
Charactercountchange
integer
differences
required
Differences
Array<object>
VersionComparisonDiffLineA single line in a version comparison diff.
object
type
required
Type
Line type: addition, deletion, or unchanged
string
content
required
Content
Line content
string
totalDifferences
required
Totaldifferences
integer
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