API Reference
Both clients expose the same 16 resource groups from the Dalux Build REST API. Method/HTTP/path tables are kept in one place per language (the client READMEs) to avoid two copies drifting apart — this page is the map to them.
| Group | Covers | JS | Python |
|---|---|---|---|
| Projects | List, get, create, update projects; project metadata | projects | projects |
| Companies | Project companies (CRUD) | companies | companies |
| Company Catalog | Account-level company catalog (CRUD + metadata) | companyCatalog | company_catalog |
| Tasks | Tasks, approvals, safety issues, observations & good practices | tasks | tasks |
| File Areas | File areas on a project | fileAreas | file_areas |
| Files | Files within a file area, browsing, downloads | files | files |
| Folders | Folders within a file area | folders | folders |
| File Upload | Chunked upload: create slot → upload parts → finalize | fileUpload | file_upload |
| File Revisions | Download file revision content | fileRevisions | file_revisions |
| Forms | Forms and form attachments | forms | forms |
| Users | Company and project users | users | users |
| Project Templates | Available project templates | projectTemplates | project_templates |
| Inspection Plans | Inspection plans, items, zones, registrations | inspectionPlans | inspection_plans |
| Test Plans | Test plans, items, zones, registrations | testPlans | test_plans |
| Version Sets | Version sets and version set files | versionSets | version_sets |
| Work Packages | Work packages on a project | workPackages | work_packages |
InspectionPlansApi and TestPlansApi mirror the Python client’s list behavior in both languages: list* methods return the typed items array by default, with a fullResponse/full_response opt-in for pagination metadata and links.
Canonical upstream docs
This repo wraps an API that Dalux controls and evolves independently. For current endpoint behavior, request/response shapes, or auth flow, the canonical source is always SwaggerHub, not this reference:
- API reference: https://app.swaggerhub.com/apis-docs/Dalux/DaluxBuild-api/
- Getting started / auth: https://app.swaggerhub.com/apis-docs/Dalux/GettingStarted/
A point-in-time copy of the spec used to build these clients is also kept at docs/official-api-docs/Dalux Build API.yaml.