Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"design",
"project"
],
"properties": {
"design": {
"type": "object",
"properties": {
"geometry": {
"type": "object",
"required": [
"levels",
"roof"
],
"properties": {
"roof": {
"type": "object",
"required": [
"type",
"pitch"
],
"properties": {
"type": {
"enum": [
"flat",
"shed",
"gable",
"hip",
"gambrel"
],
"type": "string"
},
"pitch": {
"type": "string",
"pattern": "^\\d{1,2}:12$",
"description": "Rise over 12 run, e.g. \"6:12\". Use \"0:12\" for flat."
},
"overhang": {
"type": "number",
"minimum": 0,
"description": "Eave overhang, in geometry.units. Informational."
}
},
"description": "Roof form drives a large share of the steel tonnage, so it is required rather than assumed."
},
"units": {
"enum": [
"ft",
"in",
"m",
"mm"
],
"type": "string",
"default": "ft"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"floor_to_ceiling",
"walls"
],
"properties": {
"name": {
"type": "string"
},
"index": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Storey index, 0 = ground floor."
},
"walls": {
"type": "array",
"items": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-supplied wall id, echoed back in the panel schedule."
},
"end": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"description": "Plan coordinate [x, y] in geometry.units, measured on the wall centreline."
},
"type": {
"enum": [
"exterior",
"interior"
],
"type": "string",
"default": "exterior"
},
"start": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"description": "Plan coordinate [x, y] in geometry.units, measured on the wall centreline."
},
"curved": {
"type": "boolean",
"description": "Set true for any arc or non-straight run. Curved CFS walls are not auto-panelized and route to human engineering."
},
"height": {
"type": "number",
"description": "Wall height, in geometry.units. Defaults to the level floor_to_ceiling.",
"exclusiveMinimum": 0
},
"openings": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"width",
"height"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-supplied id, echoed back in the panel schedule."
},
"type": {
"enum": [
"window",
"door",
"garage_door",
"sliding_door",
"cased_opening"
],
"type": "string",
"description": "Opening type. API v1 counts windows and doors; everything that is not a window is counted as a door because it still needs a header and full-height jambs."
},
"width": {
"type": "number",
"description": "Rough opening width, in geometry.units.",
"exclusiveMinimum": 0
},
"height": {
"type": "number",
"description": "Rough opening height, in geometry.units.",
"exclusiveMinimum": 0
},
"offset": {
"type": "number",
"minimum": 0,
"description": "Distance from the wall start point to the near jamb, in geometry.units. Supply it when you want panel seams checked against opening positions."
},
"sill_height": {
"type": "number",
"minimum": 0,
"description": "Height from finished floor to the sill, in geometry.units."
}
}
},
"default": []
},
"load_bearing": {
"type": "boolean",
"description": "Defaults to true for exterior walls, false for interior."
}
}
},
"minItems": 1
},
"footprint_area": {
"type": "number",
"description": "Enclosed floor area in geometry.units squared. Omit to have it traced from the closed exterior wall loop.",
"exclusiveMinimum": 0
},
"floor_to_ceiling": {
"type": "number",
"description": "Floor-to-ceiling height, in geometry.units. API v1 accepts 7-14 ft.",
"exclusiveMinimum": 0
}
}
},
"minItems": 1,
"description": "One entry per storey, ground floor first."
}
},
"description": "Inline structured geometry. Preferred."
},
"model_ref": {
"type": "object",
"required": [
"url",
"format"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "HTTPS URL the server can fetch. Must be readable without credentials."
},
"format": {
"enum": [
"geometry_json",
"ifc",
"ifcxml",
"glb",
"gltf",
"dxf",
"dwg",
"rvt",
"skp",
"pdf"
],
"type": "string",
"description": "Only geometry_json (this schema, serialised) is machine-readable in v1. Other formats return unsupported_design_format."
},
"sha256": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "Optional integrity check on the fetched file."
}
},
"description": "Reference to a hosted model file."
}
}
},
"options": {
"type": "object",
"properties": {
"stud_spacing_in": {
"type": "number",
"maximum": 48,
"description": "Stud spacing on centre. Defaults to 24 in, matching the engine tonnage model.",
"exclusiveMinimum": 0
},
"max_panel_length_ft": {
"type": "number",
"maximum": 40,
"description": "Longest shippable panel. Defaults to the server setting (12 ft).",
"exclusiveMinimum": 0
},
"include_panelization": {
"type": "boolean",
"default": true,
"description": "Generate the panel schedule package when the design is feasible."
}
}
},
"project": {
"type": "object",
"required": [
"type",
"jurisdiction"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"type": {
"enum": [
"residential",
"commercial",
"adu",
"garage"
],
"type": "string",
"description": "garage prices as residential framing and is labelled a garage."
},
"stories": {
"type": "integer",
"maximum": 8,
"minimum": 1,
"description": "Declared storey count. Cross-checked against the geometry."
},
"load_zone": {
"type": "object",
"properties": {
"seismic": {
"enum": [
"A",
"B",
"C",
"D",
"E"
],
"type": "string",
"description": "Seismic design category. D and E apply a multiplier."
},
"snow_psf": {
"type": "number",
"maximum": 300,
"minimum": 0,
"description": "Ground snow load. Above 50 psf the engine applies a tonnage multiplier."
},
"wind_mph": {
"type": "number",
"maximum": 250,
"minimum": 0,
"description": "Ultimate design wind speed. Above 130 mph the engine applies a multiplier."
}
},
"description": "Site loads. Omitting these means the quote carries no snow/wind/seismic uplift and is flagged as such."
},
"gauge_spec": {
"enum": [
"25ga",
"20ga",
"18ga",
"16ga"
],
"type": "string",
"description": "Steel gauge. Omit only if unknown: the quote then states 18ga as an explicit, disclosed assumption."
},
"target_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Desired delivery date. Informational, not priced."
},
"jurisdiction": {
"type": "object",
"required": [
"zip"
],
"properties": {
"ahj": {
"type": "string",
"description": "Authority having jurisdiction, if known."
},
"zip": {
"type": "string",
"pattern": "^\\d{5}$",
"description": "5-digit US ZIP of the build site. Drives fabricator routing and freight."
},
"city": {
"type": "string"
},
"state": {
"type": "string",
"maxLength": 2,
"minLength": 2
},
"code_cycle": {
"type": "string",
"description": "Governing code, e.g. \"IRC 2021\" or \"IBC 2021\". Recorded on the submission and surfaced in the compliance block."
}
}
},
"square_footage_sqft": {
"type": "number",
"description": "Declared total floor area. Cross-checked against the geometry; a large mismatch routes to human review.",
"exclusiveMinimum": 0
}
}
}
}
}