List running Archicad instances: port, version, open project, Tapir add-on availability. Call this first.

Aggregate element counts. by_type is always returned (cheap and safe). Set include_layer_story=true to also break down by layer and story, which reads a property across every element and is refused on very large models (can crash Archicad). Counts only, never element data. 'coverage' says what element_count spans: 'whole-plan' with the Tapir add-on, 'model-elements-only' without it (then it is NOT a project total).

List loaded QA rules (id, type, severity, tags) and any rule-file load errors.

Run one QA rule by id. Returns a verdict: pass/fail, failure count, failing element GUIDs.

Run all loaded QA rules (optionally only those tagged with 'ruleset') against the open model. Returns a scored verdict.

Run only the IFC-related QA rules to check IFC export readiness. Requires the Tapir add-on for IFC data.

Highlight the elements failing a rule in the Archicad window (requires Tapir add-on).

Create an Archicad issue from a rule's failures and attach the failing elements (requires Tapir add-on).

Query elements with AND-combined filters: element_type, layer, story, classification_system, selection_only. Returns GUIDs and counts, plus 'coverage': 'whole-plan' with the Tapir add-on, 'model-elements-only' without it (2D elements such as markers, labels and section lines are then invisible, so a count of 0 is not proof of absence).

Read type, layer, requested properties (address user properties as 'Group/Name') and optionally classifications for the given element GUIDs.

Write element property values. DRY-RUN BY DEFAULT: returns planned changes (current -> new) without touching the model. Pass dry_run=false to commit.

Create elements (column/slab/zone/polyline/object/mesh) via Tapir. DRY-RUN BY DEFAULT: shows the exact command and payload. Pass dry_run=false to create. Other types: use execute_api_command.

Move elements by a vector {x,y,z} in meters. Refuses without confirm=true.

Delete elements. IRREVERSIBLE. Refuses without confirm=true.

Get, set, or clear the current element selection in Archicad. action: 'get' | 'set' | 'clear'.

Project info: Archicad version, project name, stories, hotlinks, geolocation presence (Tapir enriches).

List attribute names by type: Layer, BuildingMaterial, Composite, Surface, Profile, ZoneCategory.

Manage Archicad issues (Tapir): action = list | create | comment | attach | export_bcf | import_bcf.

Fire an Archicad publisher set by name (Tapir).

Describe an exported Archicad schedule scheme XML: its criteria and its ordered columns, with what each column binds to. Schedules have no API, so export the scheme first via Document > Schedules > Scheme Settings > Export and pass the file path. Reads the file only, never Archicad.

Apply a YAML scheme spec to an exported schedule scheme XML: set the columns and their order, retarget bindings, rename the scheme. DRY-RUN BY DEFAULT: returns the before and after column lists and writes nothing until dry_run=false. Never overwrites the input; writes to 'output' or to .edited.xml beside it. Import the result via Document > Schedules > Scheme Settings > Import. Criteria are preserved, not yet editable. A spec that binds every property by GUID needs no Archicad connection and runs fully offline; a spec that binds a property by a 'Group/Name' string needs Archicad open so the name can be resolved.

Check an exported schedule scheme against the open project: do its property bindings still exist, and does any column caption disagree with what it is bound to. Reads property definitions only, not values, so it does not risk the property-read crash.

Catalog of ALL available Archicad API commands (official JSON API + Tapir), optionally filtered by group.

Full description and input schema for one API command. Call before execute_api_command.

Execute any Archicad API command by name (official 'API.*' or Tapir). Params validated against the bundled schema where available. Prefer the dedicated tools when one exists.