Inputs
Every field a model of a pile or a pile group takes, as the engine's schema gives it: what it is, its unit and convention, and its limits.
A model is a JSON document, the same one the studio’s forms build, its AI writes and an agent sends with create_model. Every element has an id, stable and unique in the model (the results name by it the elements each check depends on), and a name, shown on the canvas and in the report; strata can also carry a color. Every model states its contract_version, today 2. Units are SI: kN, m, kPa, kN/m³ and degrees.
These are its fields, from the engine’s own schema: what the studio’s forms are built from, and what get_tool_schema gives an agent.
pilegroup · required
shapetext · required · one of: circular, square
diameternumber · required · > 0
Diameter, or side of a square pile (m).
lengthnumber · required · > 0
Length below the ground surface (m).
installationtext · required · one of: bored, driven
groupgroup · optional
Piles in a rectangular grid; 1 × 1 is a single pile.
count_xinteger · optional · ≥ 1 · default 1
Piles along x.
count_yinteger · optional · ≥ 1 · default 1
Piles along y.
spacingnumber · optional · > 0 · default 1
Centre-to-centre spacing (m).
loadgroup · required
verticalnumber · required · > 0
Total vertical load on the pile, or on the whole group (kN).
soilgroup · required
stratalist · required · at least 1
Top down from the ground surface; the last stratum may leave its thickness out (it extends down).
Each item is one of:
drainedSand, or clay in the long term: beta method, with its friction angle.
thicknessnumber · optional · > 0
Thickness (m).
unit_weightnumber · required · > 0
Unit weight γ (kN/m³).
saturated_unit_weightnumber · optional · > 0
Saturated unit weight γsat (kN/m³), at least γ. Required where the stratum reaches below the water table.
behaviortext · required · = "drained"
friction_anglenumber · required · > 0 · < 90
Friction angle φ (deg).
undrainedClay in the short term: alpha method, with its undrained strength.
thicknessnumber · optional · > 0
Thickness (m).
unit_weightnumber · required · > 0
Unit weight γ (kN/m³).
saturated_unit_weightnumber · optional · > 0
Saturated unit weight γsat (kN/m³), at least γ. Required where the stratum reaches below the water table.
behaviortext · required · = "undrained"
undrained_shear_strengthnumber · required · > 0
Undrained shear strength cu (kPa).
water_tablegroup · optional
null when there is none.
depthnumber · required
Depth below the ground surface on its side (m); negative when the water stands above it.