Skip to content
HALOWERK

Propwerk

building room air volume ledger

Return net room air volumes after unioning supplied axis-aligned obstructions.

POST https://prop.halowerk.com/v1/building-room-air-volume-ledger

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
roomsarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "rooms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 48,
            "minLength": 1
          },
          "width_m": {
            "$ref": "#/$defs/s0"
          },
          "depth_m": {
            "$ref": "#/$defs/s0"
          },
          "height_m": {
            "$ref": "#/$defs/s0"
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "x": {
                  "$ref": "#/$defs/s1"
                },
                "y": {
                  "$ref": "#/$defs/s1"
                },
                "z": {
                  "$ref": "#/$defs/s1"
                },
                "w": {
                  "$ref": "#/$defs/s0"
                },
                "d": {
                  "$ref": "#/$defs/s0"
                },
                "h": {
                  "$ref": "#/$defs/s0"
                }
              },
              "required": [
                "x",
                "y",
                "z",
                "w",
                "d",
                "h"
              ],
              "additionalProperties": false
            },
            "maxItems": 10,
            "minItems": 0
          }
        },
        "required": [
          "id",
          "width_m",
          "depth_m",
          "height_m",
          "blocks"
        ],
        "additionalProperties": false
      },
      "maxItems": 30,
      "minItems": 1
    }
  },
  "required": [
    "rooms"
  ],
  "additionalProperties": false,
  "$id": "urn:h:w4:H0:input",
  "$defs": {
    "s0": {
      "type": "number",
      "minimum": 1e-06,
      "maximum": 1000000
    },
    "s1": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    }
  }
}

Open original schema

Published input example

{
  "rooms": [
    {
      "id": "room_A",
      "width_m": 4,
      "depth_m": 5,
      "height_m": 3,
      "blocks": [
        {
          "x": 0,
          "y": 0,
          "z": 0,
          "w": 1,
          "d": 1,
          "h": 2
        },
        {
          "x": 0,
          "y": 0,
          "z": 1,
          "w": 1,
          "d": 1,
          "h": 2
        }
      ]
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-18 UTC.

More endpoints in this hub

All endpoints in this hub โ†’