Dalux Build (Client Libraries Py/JS & Webhooks) by bruadam

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.

Warning

These API clients are experimental and not yet fully tested. Use at your own risk. Suspect ground-breaking, backwards-incompatible changes in the near future — pin to a specific version. Report issues on GitHub.

Important

This is an independent, unofficial project. It is not affiliated with, endorsed by, sponsored by, or supported by Dalux ApS. It provides no Dalux subscription, API access, or credentials. Every user must supply their own valid Dalux access and use it only within their agreement with Dalux. The maintainer has never contacted Dalux about this project; no approval, permission, confirmation, or endorsement has been requested or received.

The MIT license permits use of this repository's original code, including commercial use, but grants no rights to Dalux's services, API, documentation, trademarks, accounts, or data. Commercial, multi-customer, or hosted use of the code does not authorize the corresponding use of Dalux. Confirm that use with Dalux under your own agreement. See the Legal and Usage Notice.

Maintained by Bruno Adam.

Get Started

npm install dalux-build-api

const { createClient } = require("dalux-build-api");

const dalux = createClient({
  baseUrl: "https://<company>.dalux.com/api",
  apiKey: "YOUR_API_KEY",
});
const projects = await dalux.projects.listProjects();

pip install dalux-build

from dalux_build import create_client

dalux = create_client(base_url="https://<company>.dalux.com/api", api_key="YOUR_API_KEY")
projects = dalux.projects.list_projects()

Full guides (auth, pagination, file upload, dataframes, error handling, all 16 API groups): javascript/README.md · python/README.md.

Choose your setup

Piece	Best for	Docs
Node.js 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 how they fit together? See Architecture.

Documentation

Full documentation site: https://bruadam.github.io/dalux-build/

Start here	Getting Started · Architecture
Clients	JavaScript · Python
Webhook infra	Webhook Server · Webhook UI · n8n node
Reference	API Reference · Tutorials
Contributing	Contributing Guide

AGENTS.md has pointers to the canonical upstream Dalux Build API docs and where each client's API surface lives in this repo.

Testing & Releasing

All packages are tested from one shared workflow and released together by Changesets — no manual version bumps, nothing publishes unless the full suite passes. See CONTRIBUTING.md for commands and the full release flow.

Community

Issues for bugs and feature requests · Discussions for questions.

License

The original code in this repository is licensed under the MIT License. That license covers this project only and does not grant rights to Dalux's services or other intellectual property. See the Legal and Usage Notice.