Getting Started

You'll be up and running in a jiffy.

The Q3D Sensing API lets you upload point cloud files and extract structured spatial measurements. You specify what to measure (a measurement function such as volume) and the spatial context it applies to (a scene such as pool). This Measurement × Scene model gives a single endpoint for every measurement type.

Introduction

Q3D Sensing exposes a REST API organized around predictable resource URLs. All requests are authenticated with an API key passed as a Bearer token. Responses are returned as JSON.

The base URL for all API requests is:

https://api.q3dsensing.com/v1

Entity Hierarchy

All Q3D Sensing data is organized into the following hierarchy:

Account
├── API Keys
└── Scans
    ├── file metadata
    ├── status
    └── Measurements
        ├── volume(pool) → US gallons
        └── area(room)   → sq ft