Dalux Build API
Node.js and Python clients for the Dalux Build REST API, plus a webhook server, registration UI, dev playground, and n8n node built on top of them — because Dalux itself doesn’t push webhooks; see Architecture for how the pieces fit together.
These clients are experimental. Pin to a specific version — see the repo README for the full disclaimer.
This is an unofficial project and provides no Dalux access or credentials. Using the MIT-licensed code commercially does not authorize commercial use of Dalux’s API or Services. Each user must have their own valid Dalux access and comply with their own agreement. Read the Legal and Usage Notice before use, especially for hosted or multi-customer deployments.
Choose your setup
| Piece | Best for | Source |
|---|---|---|
JavaScript client (dalux-build-api) | Scripting or app code in JS/TS | javascript/ |
Python client (dalux-build) | Scripting, notebooks, data analysis | python/ |
| Webhook server | Turning Dalux’s polling-only API into real webhooks | webhook-server/ |
| Webhook UI | Registering/managing webhook jobs without curl | webhook-ui/ |
| Playground | Exercising the JS client interactively, server-side | playground/ |
| n8n node | Wiring Dalux into n8n workflows | n8n-nodes-dalux-build/ |
Not sure where to start? Read Getting Started.
Sections
- Getting Started — install and make your first call
- Architecture — how the client libraries, webhook server, UI, playground and n8n node relate
- JavaScript Client · Python Client
- Webhook Server · Webhook UI · n8n Node
- API Reference — the 16 shared endpoint groups
- Tutorials — 5-hour notebook series for the Python client
- Legal and Usage Notice — affiliation, licensing, credentials, and commercial or hosted use
- Contributing — tests, changesets, releases