Getting Started

Before continuing, read the Legal and Usage Notice. This project does not provide Dalux access. You need your own authorized account and must keep every use within the scope of your agreement with Dalux.

Both clients need two things from your Dalux Build account:

  1. DALUX_API_KEY — your company’s API key (Dalux Build UI → Company Profile → Settings → Company overview → API Identities; ask Dalux support to activate API access for your company profile if you don’t see this menu)

Refer to Dalux Build API documentation for more information on how to generate an API key.

  1. DALUX_BASE_URL — the API base URL for your Dalux node for most Dalux Build customers, this is https://node1.field.dalux.com/service/api/ but some customers are on a different node.

Every request from either client sends the key as the X-API-KEY header automatically; no other auth configuration is needed.

Node.js 

npm install dalux-build-api

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

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

const projects = await dalux.projects.listProjects();

Requires Node.js 14+. For calling the API from a browser (Client Components, no CORS, key never reaches the browser), see the Next.js adapter in JavaScript Client.

Full guide, every namespace, and the 16 API-group reference table: javascript/README.md.

Python 

pip install dalux-build

from dalux_build import create_client

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

projects = dalux.projects.list_projects()

Requires Python 3.10+. Set a default project_id / file_area_id on the client if you mostly work against one project — see Python Client.

Full guide, every namespace, full_response/to_dataframe, and the 16 API-group reference table: python/README.md.

Next steps

  • Read Architecture to see how the webhook server, UI, playground, and n8n node build on these two clients.
  • Browse the API Reference for what each endpoint group covers.
  • Run the Tutorials notebooks for a guided walkthrough.