Core resources
Before diving into the API, it helps to understand the key resources you'll be working with and how they relate to each other. This page gives you the big picture.
iGUIDE
An iGUIDE is the central resource — it represents a complete property documentation package combining floor plans, panoramic 3D tours, and precise measurements, all generated from a single property scan.
When you create an iGUIDE, you choose a package and an industry. The system automatically creates a default view and an initial work order for you.
When you create an iGUIDE with the API, the following object is returned:
| Field | Example | Description |
|---|---|---|
id | igAB3XR9M2 | Immutable primary key. Always starts with ig. |
alias | 200-university-ave-waterloo-ca | Mutable URL slug derived from the address. |
type | standard | Package type: standard, premium, radix, or photos. |
industry | residential | Industry type: residential, commercial, irc, or aec. |
defaultViewId | vXY7P2R1A | The default view, created automatically. |
workOrderId | Z1T9 | The initial work order, created automatically. |
The iGUIDE ID is the only identifier you need to store. From it, you can look up everything else — views, work orders, alias, and deliverables.
View
A View is a presentation layer on top of an iGUIDE. It controls who can see the iGUIDE, when access expires, and how it's branded. One iGUIDE can have multiple views — useful for sharing the same property scan with different audiences.
Every iGUIDE has exactly one default view, created automatically. You can create additional views with different access controls, expiration dates, and branding.
| Field | Example | Description |
|---|---|---|
id | vXY7P2R1A | Immutable identifier. Always starts with v. |
isDefault | true | Whether this is the auto-created default view. |
isProtected | false | Public (anyone with URL) vs. protected (requires auth). |
expiresAt | 2027-01-01T00:00:00Z | When the view locks. Can be extended. |
bannerId | b_abc123 | Optional banner for contact info display. |
measStd | rms | Measurement standard: ansi or rms. |
Default protection by industry:
- Residential: public (unprotected)
- Commercial, IRC, AEC: protected
The default view cannot be deleted. Additional views can be deleted, but deletion is permanent — there is no undo.
Work order
A Work Order represents a specific piece of processing work. The initial work order handles base floor plan drafting and is created automatically. Additional work orders are created through the API when you need add-on deliverables like CAD floor plans, 3D models, or ESX reports.
Each work order tracks its own status independently. You can have multiple work orders in progress at the same time.
| Field | Example | Description |
|---|---|---|
id | Z1T9 | Immutable alphanumeric identifier. |
status | done | Current processing status (see Work Order Lifecycle). |
iguideId | igAB3XR9M2 | The parent iGUIDE. |
iguideType | standard | Package type of the parent iGUIDE. |
stitchDataId | 4MN | ID of the stitch data associated with this work order. |
attrs | {"units": "imperial"} | Task-specific attributes. |
Terminal statuses: done (deliverables ready), cancelled, rejected (data quality issue). Any other status means the work order is still being processed.
Views and work orders are independent. Views control how an iGUIDE is displayed. Work orders control what processing gets done. There is no direct relationship between them.
Package
The package type you choose when creating an iGUIDE determines how it's processed, what deliverables you get, and what add-ons you can order later.
| Package | Processing | What You Get |
|---|---|---|
| Standard | ~24 hours (manual drafting)* | Precise floor plans, 3D tours, RMS/ANSI measurements. |
| Premium | ~24 hours (manual drafting)* | Everything in Standard, plus VR tours and eligibility for 3D models (Revit). |
| Radix | Minutes (automated)* | 3D virtual tour with point cloud. No floor plans. |
| Photos | Instant | Gallery images only. No 3D tour, floor plans, or measurements. |
For the full breakdown of deliverables, add-on task types, and upgrade paths, see Packages & Industry Types.
Stitch Data
Stitch Data is the raw scan captured by the iGUIDE camera, packaged as a TAR file. You upload it to S3 and trigger processing — this is what kicks off the floor plan drafting pipeline.
The upload follows a three-step process:
- Get upload permit — request temporary S3 credentials from the API
- Upload to S3 — upload the TAR file directly using the credentials
- Trigger processing — tell the API to begin processing the upload
| Field | Example | Description |
|---|---|---|
id | 4MN | Immutable alphanumeric identifier. |
uploadToken | (string) | Token needed when triggering processing. |
uploadPermit | (object) | Temporary AWS credentials for S3 upload. |
The Stitch Data ID is only needed during the upload flow. You can discard it after processing completes.
Webhook
Webhooks let you receive push notifications instead of polling for status changes. Register a webhook URL when creating an iGUIDE, and the system will POST to your endpoint when events occur.
Currently, the only supported event is ready — fired when the iGUIDE is published and all base deliverables are available. The payload includes URLs, property info, billing details, and a temporary auth token valid for 3 weeks.
| Field | Description |
|---|---|
event | Event type (ready). |
url | Your HTTP endpoint. |
Delivery guarantees: On HTTP 5xx, the system retries up to 5 times at 10–15 minute intervals. On 4xx or 3xx, the event is dropped.
Banner
A Banner is a reusable contact information template displayed on iGUIDE views — containing name, title, company, phone numbers, emails, and social links. Banners are shared across iGUIDEs and applied via bannerId when creating an iGUIDE or configuring a view.
Asset
An Asset is a user-uploaded file (photo, document, etc.) associated with an iGUIDE. Assets follow the same three-step upload flow as Stitch Data: get upload permit, upload to S3, trigger processing.
Related resources
- iGUIDE Lifecycle — how an iGUIDE moves through processing states
- Work Order Lifecycle — the work order state machine
- Packages & Industry Types — what each package includes
- S3 Upload Pattern — the three-step upload flow in detail
- Resource Identifiers — which IDs to store and how they correlate
- View Access & Expiration — managing view access and locking