API referenceSpatial roomsRoom scansScanidPlacementsResourceid
Create or replace an item's current indoor 3D placement
The API runs on your own Open Inventory instance. Session-authenticated requests require a session on that instance.
PUT
The scan must still be the active revision. Coordinates use its ARKit world frame in metres.
bearerAuthheader
AuthorizationBearer <inv_ token>scanId*stringFormat
uuidresourceId*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
uuidapplication/json- body
position*array<>XYZ values in metres.
Items
3 <= items <= 3orientation*array<>Normalized XYZW quaternion.
Items
4 <= items <= 4extent?array<>Items
3 <= items <= 3confidence*numberRange
0 <= value <= 1method*stringValue in
"scene-depth""mesh-raycast""plane-raycast""manual"anchorIdentifier?stringFormat
uuidcapturedAt*stringFormat
date-timelocalizationEvidence?Placement saved
curl -X PUT 'https://inventory.example.com/api/v1/room-scans/497f6eca-6276-4993-bfeb-53cbbbba6f08/placements/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{ "position": [ -10000, -10000, -10000 ], "orientation": [ -1, -1, -1, -1 ], "confidence": 0, "method": "scene-depth", "capturedAt": "2019-08-24T14:15:22Z"}'Example Response
Empty