Reference overview¶
Stub page
Placeholder content. Per-component reference pages will land as the documentation is written.
System shape¶
cadwork.ai is a small number of cooperating services:
| Component | Responsibility |
|---|---|
| Orchestrator | Hosts the agent loop, the task graph, memory, and skills. |
| Web UI | The multi-pane chat workspace, streaming from the orchestrator. |
| Knowledge servers | Retrieval over the cadwork API docs, guides, and videos. |
| Model bridge | Exposes the running cadwork 3D session as callable tools. |
Example: asking about the open model¶
A request from the UI reaches the orchestrator, which decides it needs the live model and calls the bridge:
from cadwork_ai import Session
session = Session.connect()
elements = session.model.elements(kind="beam")
for element in elements:
print(element.id, element.name, element.length_mm)
The same call shape is available from the assistant itself, you rarely write this by hand, but it is what the assistant is doing on your behalf.
Conventions used in this documentation¶
- Lengths are millimetres unless stated otherwise.
- Element identifiers are stable only within a single open model.
- Anything marked stub is a placeholder, not a documented guarantee.