Open Inventory / Docs
EndpointsSpatial roomsRoom scansScanidLayout

Position one room inside its floor layout

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.

PATCH
/room-scans/{scanId}/layout

Requires spatial management permission. The transform is a column-major world-from-model matrix in metres. Set it to null to restore automatic floor arrangement.

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

scanId*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
transform*array<>|null

Response Body

Room layout position updated

Example Request
curl -X PATCH 'https://inventory.example.com/api/v1/room-scans/497f6eca-6276-4993-bfeb-53cbbbba6f08/layout' \  -H 'Content-Type: application/json' \  -d '{  "transform": [    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000,    -10000  ]}'
Example Response
Empty

Download an authenticated RGB localization keyframe GET

Previous Page

Remove an item's placement from this scan DELETE

Next Page