Open Inventory / Docs
EndpointsSpatial roomsRoom scansScanidKeyframesKeyframeid

Download an authenticated RGB localization keyframe

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
/room-scans/{scanId}/keyframes/{keyframeId}

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

scanId*string
Formatuuid
keyframeId*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

Response Body

Inline JPEG keyframe

response?fileimage/jpeg
Formatbinary
Example Request
curl -X GET 'https://inventory.example.com/api/v1/room-scans/497f6eca-6276-4993-bfeb-53cbbbba6f08/keyframes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
"string"

Attach or replace a photorealistic room derivative PUT

Accepts raw GLB bytes for textured_mesh or raw bounded PLY bytes for gaussian_splat. Vertices must already use the scan's shared ARKit world frame (metres, right-handed, Y-up); no alignment transform is inferred. The web client renders PLY as a bounded point-splat preview; textured GLB is the full photorealistic path. This mutable enrichment does not change the idempotent identity of the original room capture. Content-Length is required before the server buffers the body.

Position one room inside its floor layout PATCH

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.