Compare

Trigger an asynchronous comparison between two drawings. The system matches sheets between the drawings, generates overlays for each matched block pair, and detects changes and clashes. Returns a job_id for polling.

When to Use

Compare two revisions of the same drawing set (e.g., Rev A vs Rev B)
Detect cross-discipline clashes between structural and mechanical drawings
The user asks “what changed” between drawing versions

Comparison is an async operation that consumes credits. It may take seconds to minutes depending on the number of sheets. Use PollJob to poll for completion.

Parameters

Parameter	Type	Required	Description
`project_id`	string	yes	Project scope
`drawing_a_id`	string	yes	First drawing (typically the older revision)
`drawing_b_id`	string	yes	Second drawing (typically the newer revision)

Response

{
  "job_id": "job_cmp_01",
  "status": "queued"
}

Field	Type	Description
`job_id`	string	Use with `PollJob` to poll status
`status`	string	Initial status, always `"queued"`

Workflow

Identify the drawings

Use Query with entity: "sheet" to find sheets and their parent drawing IDs. Filter by discipline or search by name.

Trigger comparison

Call Compare with both drawing IDs. Note the returned job_id.

Poll for completion

Call PollJob with the job_id. The job progresses through queued > started > completed.

Inspect results

Once complete, use Query with entity: "block" and include: ["overlays", "changes"] on the compared blocks to get detailed change descriptions.

Example

Compare architectural revisions

First, find the drawings:

// Query
{
  "entity": "sheet",
  "project_id": "proj_oak",
  "discipline": "A"
}
// Response includes sheets from both "Arch Set Rev A" (dr_arch_a)
// and "Arch Set Rev B" (dr_arch_b)

Then trigger the comparison:

// Compare
{
  "project_id": "proj_oak",
  "drawing_a_id": "dr_arch_a",
  "drawing_b_id": "dr_arch_b"
}

// Response
{
  "job_id": "job_cmp_01",
  "status": "queued"
}

PollJob - Poll the comparison job for status and results
Query - Find drawings and their IDs before comparing, fetch change and clash details after
ViewImage - View overlay images showing additions and deletions

Overview

Tools

Workflows

Reference

When to Use

Parameters

Response

Workflow

Example

Compare architectural revisions

​When to Use

​Parameters

​Response

​Workflow

​Example

​Compare architectural revisions

​Related Tools

When to Use

Parameters

Response

Workflow

Example

Compare architectural revisions

Related Tools