Skip to main content
Overlays are the result of comparing two Blocks from different drawing revisions. They contain aligned images showing additions (green) and deletions (red).

Endpoints

MethodEndpointDescription
POST/drawings/{id}/compareCompare two drawings
POST/sheets/{id}/compareCompare two sheets
GET/overlaysList overlays
GET/overlays/{id}Get overlay details
DELETE/overlays/{id}Delete an overlay

Overlay Object

FieldTypeDescription
idstringUnique identifier (e.g., ovl_01JABCD123)
block_a_idstringSource Block (older revision)
block_b_idstringTarget Block (newer revision)
job_idstringComparison job that created this overlay
uristringCombined overlay image URL
addition_uristringAdditions-only image URL
deletion_uristringDeletions-only image URL
aligned_a_uristringAligned source block image
aligned_b_uristringAligned target block image
scorenumberSimilarity score (0-1, lower = more changes)
summaryobjectChange statistics
changesarrayDetected changes (after change detection)
created_atdatetimeCreation timestamp

Similarity Scores

ScoreInterpretation
0.95+Nearly identical, minor changes
0.80-0.95Moderate changes
0.60-0.80Significant changes
< 0.60Major revisions or different content