EndpointsSpatial roomsRoom scansScanid
Retrieve a web-viewer scene with positioned inventory
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
GET
bearerAuthheader
AuthorizationBearer <inv_ token>scanId*stringFormat
uuidX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
Format
uuidNormalized room scene, assets, and current placements attached to this revision
application/json- response
scene*curl -X GET 'https://inventory.example.com/api/v1/room-scans/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "scene": { "structureId": "0e8c4ba3-b757-4e4a-9e0e-448fab22d027", "structureName": "string", "coordinateSpaceId": "f9241048-4b84-4d22-a9bb-373349d8381b", "floorIdentifier": "string", "floorIndex": 0, "roomIdentifier": "string", "georeference": { "latitude": -90, "longitude": -180, "altitude": -12000, "headingDegrees": 0, "horizontalAccuracy": 0, "verticalAccuracy": 0, "capturedAt": "2019-08-24T14:15:22Z", "source": "gps", "localReferencePosition": [ 0, 0, 0 ], "referencePoints": [ { "id": "string", "label": "string", "localPosition": [ -10000, -10000, -10000 ], "latitude": -90, "longitude": -180, "altitude": -12000 } ], "entryMarkerCode": "string" }, "room": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string" }, "scan": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "structureId": "0e8c4ba3-b757-4e4a-9e0e-448fab22d027", "structureName": "string", "coordinateSpaceId": "f9241048-4b84-4d22-a9bb-373349d8381b", "floorIdentifier": "string", "floorIndex": 0, "roomIdentifier": "string", "layoutTransform": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "georeference": { "latitude": -90, "longitude": -180, "altitude": -12000, "headingDegrees": 0, "horizontalAccuracy": 0, "verticalAccuracy": 0, "capturedAt": "2019-08-24T14:15:22Z", "source": "gps", "localReferencePosition": [ 0, 0, 0 ], "referencePoints": [ { "id": "string", "label": "string", "localPosition": [ -10000, -10000, -10000 ], "latitude": -90, "longitude": -180, "altitude": -12000 } ], "entryMarkerCode": "string" }, "revision": 1, "status": "active", "scene": { "schemaVersion": 1, "coordinateSystem": "arkit-right-handed-y-up", "units": "meter", "matrixOrder": "column-major", "worldFromModel": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "webFromWorld": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "bounds": { "min": [ -10000, -10000, -10000 ], "max": [ -10000, -10000, -10000 ] }, "surfaces": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "category": "string", "dimensions": [ 0, 0, 0 ], "transform": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "polygonCorners": [ [ -10000, -10000, -10000 ], [ -10000, -10000, -10000 ], [ -10000, -10000, -10000 ] ], "confidence": "low" } ], "objects": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "category": "string", "dimensions": [ 0, 0, 0 ], "transform": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "polygonCorners": [ [ -10000, -10000, -10000 ], [ -10000, -10000, -10000 ], [ -10000, -10000, -10000 ] ], "confidence": "low" } ] }, "capturedAt": "2019-08-24T14:15:22Z", "deviceModel": "string", "assets": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "world_map", "name": "string", "mimeType": "string", "size": 0, "checksumSha256": "string", "url": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "keyframes": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "capturedAt": "2019-08-24T14:15:22Z", "timestamp": 0, "cameraTransform": [ -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000, -10000 ], "intrinsics": [ 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "width": 1, "height": 1, "orientation": "up", "quality": 0, "mimeType": "image/jpeg", "size": 1, "checksumSha256": "string", "url": "string" } ] }, "placements": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "resource": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "type": "string", "status": "string", "location": "string", "cover": {} }, "position": [ -10000, -10000, -10000 ], "orientation": [ -1, -1, -1, -1 ], "extent": [ 0, 0, 0 ], "confidence": 0, "method": "scene-depth", "anchorIdentifier": "7f378df2-3c50-49a1-a520-71237b76906b", "localizationEvidence": { "matchedKeyframeId": "58a8e472-4438-4384-b2d9-e4af25388763", "distance": 0, "confidence": 0, "cameraPositionError": 0 }, "capturedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] }}Upload a normalized RoomPlan scan and its native assets POST
Requires write scope. The client-generated scan id makes exact retries idempotent. The referenced resource must have type `place`. RGB keyframes carry ARKit camera poses and intrinsics in the scan's coordinate space; each JPEG part name must match its metadata fileField.
Download an authenticated native room-scan asset GET
Next Page