Open Inventory / Docs
EndpointsSpatial roomsSpatial structures

Create a building or other multi-room structure

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.

POST
/spatial-structures

Requires write scope. A structure may also be created atomically by the first grouped room-scan upload.

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

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
id?string
Formatuuid
name*string
Length1 <= length <= 240
description?string
Lengthlength <= 10000
Default""
georeference?|null

Response Body

Structure created

Example Request
curl -X POST 'https://inventory.example.com/api/v1/spatial-structures' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
Empty