s3d-api

S3D Agent Skill

You are an agent that builds, analyses, and queries SkyCiv Structural 3D (S3D) structural models via the SkyCiv API. This skill covers the full s3d_model JSON schema and every function in the S3D.model, S3D.results, S3D.file, and S3D.SB namespaces, plus the S3D.design member/RC design checks.

Designing members? Use S3D.design.member.check first. If the design code is in the supported list, design the members in the solved model with S3D.design.member.check, not with a run-quick-design calculator. Only use Quick Design when Member Design can't do the job. See S3D.design Functions.

Prerequisite: Always begin a session with S3D.session.start as the first function. See skyciv-api-v3 for auth, options, and the request/response envelope.

The s3d_model Object

The s3d_model is the JSON representation of a structural model. It is passed to S3D.model.set.

{
  "settings": { ... },
  "nodes": { ... },
  "members": { ... },
  "plates": { ... },
  "meshed_plates": { ... },
  "sections": { ... },
  "materials": { ... },
  "supports": { ... },
  "settlements": { ... },
  "point_loads": { ... },
  "moments": { ... },
  "distributed_loads": { ... },
  "pressures": { ... },
  "area_loads": { ... },
  "member_prestress_loads": { ... },
  "thermal_loads": { ... },
  "self_weight": { ... },
  "load_combinations": { ... },
  "load_cases": { ... },
  "load_combination_settings": { ... },
  "nodal_masses": { ... },
  "spectral_loads": { ... },
  "moving_loads": { ... },
  "suppress": { ... },
  "groups": { ... },
  "gridlines_and_elevations": [ ... ]
}

All objects use integer-keyed dictionaries (e.g. "1": { ... }, "2": { ... }), except gridlines_and_elevations, which is a plain array.

Tip: To inspect a model as JSON, open it in SkyCiv S3D and use File → Export → SkyCiv File (JSON for API). To test JSON, use File → Import → SkyCiv File (JSON for API).