Skip to main content
Convert a storage URI (returned in every entity’s uri field) to a time-limited signed URL that can be displayed in a browser or embedded in a response. Called only when the agent needs to present a visual to the user.

​
When to Use

  • Show the user an image of a sheet, block, feature, or overlay
  • Display a comparison overlay (composite, additions, or deletions layer)
  • Present a cropped feature image alongside analysis results
  • Attach reference images to an RFI draft
Most queries do not need images. Only call ViewImage when the user asks to see something or when a visual reference adds value (e.g., showing an overlay alongside a change description).

​
Parameters

​
Response

Signed URLs expire after expires_in seconds. Do not cache them beyond that window. Call ViewImage again if the URL has expired.

​
Examples

​
Show an overlay comparison image

Returns a signed URL for the composite overlay image showing additions (green) and deletions (red) between two drawing revisions.

​
Show a feature crop

Returns a signed URL for the cropped image of door 104, useful for attaching to an RFI or including alongside a schedule cross-reference.
  • Query - Sheet, block, overlay, and feature responses include uri fields
  • Compare - Comparison results include overlay uri fields
  • Parse - Parsed features include uri for cropped images