Base URL: https://3d.scanifly.com

3D Viewer — URL Query Parameter Reference

Authentication & Identity

token

JWT access token for API authentication. Required for editing.

• Type: string
• Default: ''
• Example: ?token=eyJhbGci...

ID

Project ID to load.

• Type: string (cast to ProjectId)
• Default: ''
• Example: ?ID=abc123

did

Design ID within the project to load.

• Type: string (cast to DesignId)
• Default: ''
• Example: ?did=xyz789

Environment / Mode Flags

embed

Activates embedded mode. Presence of the parameter (any value) enables it.

• Type: boolean flag (presence = true)
• Default: absent → false
• Effects:
  • Hides toolbar and most UI elements
  • Hides Lidar and Google Solar layer controls
  • Disables zoom-on-scroll (same as controls=embed)
  • Reduces memory limits for photogrammetry and Google Solar models
  • Disables FullStory/Heap analytics initialization
  • Disables keyboard event delegation
  • Disables legacy tools
  • Prevents design-mode from taking effect
• Example: ?embed

design-mode

Overrides the user's stored design mode preference.

• Type: enum — simple | pro
• Default: absent → user preference from settings API is used
• Effects:
  • simple: forces Simple Design V2 UI regardless of user preference or feature flags
  • pro: forces Pro (full) design UI
  • Ignored when embed is present
  • Removed from the URL automatically after the user toggles design mode
• Example: ?design-mode=simple

Controls & Interaction

controls

Sets the camera/scroll control scheme.

• Type: enum — embed | default
• Default: default
• Effects:
  • embed: disables zoom-on-scroll (controls.noZoom = true); user must hold Ctrl to scroll-zoom — intended for use when the viewer is inside an iframe where page scroll should not be consumed
  • default: normal scroll-to-zoom behavior
• Example: ?controls=embed

usage

Restricts editing in the utility consumption section of Simple Design.

• Type: enum — readonly
• Default: absent → editing allowed
• Effects: readonly disables the consumption value inputs
• Example: ?usage=readonly

Simple Design UI State

These parameters only have visible effect when Simple Design V2 is active (via user permission, settings, or design-mode=simple).

widget

Controls the initial expansion state of the Simple Design widget panel.

• Type: enum — closed
• Default: absent → widget opens normally
• Effects: closed collapses the widget on load
• Example: ?widget=closed

accordion

Sets which accordion section is expanded on load.

• Type: enum — system
• Default: absent → default accordion state
• Effects: system expands the system accordion section
• Example: ?accordion=system