Getting Started
Runchat for Archicad integrates the full Runchat web app directly into Archicad through a dockable palette. Capture viewport screenshots as inputs to AI workflows and run Python scripts that read and analyze your model — without leaving Archicad.Install the Add-On
Requires Archicad 29 on Windows.Download Runchat for Archicad
Add-On for Archicad 29 (Windows)
1
Add in Archicad
Open Archicad → Options → Add-On Manager → Edit List of
Available Add-Ons → Add and select the downloaded
Runchat.apx file.2
Enable
Make sure the checkbox next to Runchat is ticked, then click OK.
3
Restart Archicad
Restart Archicad so it can build the Runchat menu. The Runchat menu
only appears after a restart.
4
Open the palette
Choose Runchat → Runchat Palette. Log in with your Runchat account
and you’re ready to go.
Bridge capabilities
The palette runs the full Runchat web app and communicates with Archicad through a local bridge.- Viewport capture: Send the active Archicad window (plan, section, or 3D) as an image input to AI workflows, or let the agent take screenshots to verify its work.
- Python scripts: Code nodes set to ArchiCAD Python run against your live model through the Archicad JSON API — list and filter elements, read properties, classifications, stories, and bounding boxes, and feed results into workflows. With the free Tapir add-on installed, scripts can also create and modify walls, slabs, columns, objects and other elements.
Running scripts
Scripts use the officialarchicad Python package and run in a local Python process. One-time setup:
1
Install Python 3
Install Python 3 from python.org if
you don’t already have it (tick “Add python.exe to PATH” in the
installer).
2
The archicad package
The first script you run installs Graphisoft’s
archicad package for that
Python automatically. If that fails (for example offline), run
pip install archicad in a terminal.3
Enable the JSON connection
In Archicad, make sure the JSON/Python interface is enabled so scripts can
connect (Options → Work Environment).
conn, acc (commands), act (types), and acu (utilities) — and anything you print() becomes the node output.
Modelling with Tapir
The official Archicad JSON API is read and analysis focused: on its own, scripts can query elements, properties, and project structure but cannot create geometry. To let scripts and the agent model, install Tapir, a free open-source add-on that adds hundreds of commands for creating, modifying, and deleting elements.1
Install Tapir
When Tapir isn’t loaded, the Runchat palette shows an Install Tapir
bar. Click it and approve the Windows administrator prompt: Runchat
downloads the latest Tapir release from GitHub, checks it against GitHub’s
checksum, and copies it into Archicad’s Add-Ons folder. Restart Archicad to
load it. You can also install it yourself from
archicad-api.com.
2
Ask for model changes
The agent checks that Tapir is installed before modelling. Each command a
script runs is a single undo step, so you can step back through the
changes with Ctrl+Z.
Updates
The palette checks for updates automatically when it loads. If a newer version is available, you’ll see a banner at the top of the panel with a download link. Install the new.apx over the old one via the Add-On Manager.
Troubleshooting
Script nodes fail with 'Python was not found'
Script nodes fail with 'Python was not found'
Install Python 3 and make sure
python.exe is on your PATH, or set the
RUNCHAT_PYTHON environment variable to the full path of a python.exe.Script nodes fail with 'archicad package is not installed'
Script nodes fail with 'archicad package is not installed'
Runchat tried to install it and failed; the error shows the exact command.
Run
pip install archicad in a terminal using the same Python
installation the plugin found.Installing Tapir failed
Installing Tapir failed
The bar shows the reason. If you declined the administrator prompt, click
Retry. Otherwise install Tapir from
archicad-api.com and restart Archicad.
Scripts can't reach the Archicad JSON API
Scripts can't reach the Archicad JSON API
Enable the JSON/Python connection in Archicad’s settings and retry. If you
have multiple Archicad instances open, scripts connect to the first one
that responds — close extra instances if the wrong project is targeted.
Login problems in the palette
Login problems in the palette
If a third-party sign-in provider refuses to load inside the embedded
browser, sign in with your email and password instead.
Need Help?
- Community: Join our Discord for help and inspiration