canonical: https://jentic.com/apis/dalux.com/dalux

# Dalux Field API

Dalux Field is a construction field-management platform, and this API (TryBuildAPI) exposes its project data. With a company API key, an integration can read projects and their metadata, users and companies, work packages, file areas, folders, files and version sets, and the full task surface of approvals, safety issues, observations, inspection plans, test plans, and forms. It also supports chunked file uploads and a company directory of registered firms.

## For AI agents

Lets an AI agent read Dalux Field construction projects, documents, version sets, tasks, inspections, and forms, and upload files, using a company API key.

## Scope

Does not handle accounting, procurement, or scheduling data: use it to read Dalux Field projects, documents, and tasks and to upload files only.

## Capabilities

- Read projects, their metadata, users, and companies
- Browse file areas, folders, files, and version sets
- Retrieve file content and revision history
- Read tasks, approvals, safety issues, and observations
- Browse inspection plans, test plans, and their registrations
- Upload files in chunks and retrieve project forms

## Use cases

### Construction document access

Field and office teams need the latest drawings and files from a project. The Dalux Field API browses file areas, folders, files, and version sets and retrieves file content, so a tool can surface the current document for a given project.

Example prompt: Browse a project's file areas and retrieve the latest revision of a named file

### Safety and inspection tracking

Site managers track safety issues and inspection progress. The API reads tasks, approvals, safety issues, observations, and inspection and test plan registrations, so a dashboard can report open items per project.

Example prompt: List a project's safety issues and inspection plan registrations and summarize open items

### Agent-driven field assistant

A field assistant can answer project questions and file documents. Through Jentic, an agent resolves a request about a project into reading its files and tasks and, when asked, uploading a document through the chunked upload flow.

Example prompt: Read a project's open tasks and files, then upload a new document to the right file area

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/5.1/projects` | Get all available projects |
| GET | `/5.0/projects/{projectId}` | Get a specific project |
| GET | `/5.1/projects/{projectId}/file_areas` | Get a project's file areas |
| GET | `/6.0/projects/{projectId}/file_areas/{fileAreaId}/files` | Browse files in a file area |
| GET | `/5.1/projects/{projectId}/tasks` | Retrieve tasks, approvals, and safety issues |
| POST | `/1.0/projects/{projectId}/file_areas/{fileAreaId}/upload` | Create a file upload slot |

## Key resources

- **Projects** — Projects, their metadata, users, and companies
- **File areas and files** — File areas, folders, files, and file content
- **Version sets** — Version sets and the files within them
- **Tasks and inspections** — Tasks, approvals, safety issues, inspection plans, and test plans
- **Forms** — Project forms and their attachments
- **Company directory** — Companies registered on the company profile

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 54 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 48 / 100
  - Developer Experience & Jentic Compatibility: 54 / 100
  - AI-Readiness & Agent Experience: 41 / 100
  - Agent Usability: 93 / 100
  - Security: 50 / 100
  - AI Discoverability: 62 / 100
- **View full report:** https://jentic.com/apis/dalux.com/dalux/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Dalux wiring is one company API key plus 59 project operations with versioned path prefixes. With Jentic One you install once, import the operations you need from the API Directory, and keep the key in one place.
- **Permission scoping:** Projects, file areas, and files are addressed by ids in the path, so you can scope an agent to specific projects and to read operations while keeping file uploads out of reach.
- **Credential handling:** Your Dalux API key is stored encrypted by your own Jentic One instance and injected when a call runs, so it never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents find the right Dalux operation through Jentic's intent search, matching a request like listing a project's files to the matching endpoint.

## Related APIs

- **Procore** — Construction management platform with project and document APIs
- **Trimble Connect** — Construction collaboration and model data platform
- **Smartsheet** — Work and project tracking in sheets

## FAQ

### How does the Dalux Field API authenticate?

Dalux expects a company-specific API key in the `X-API-KEY` header, tied to an API identity in your Dalux settings. Jentic One stores that key and injects it at execution time.

### Can I limit what my agent is allowed to do with Dalux Field?

Yes. Projects, file areas, and files are addressed by ids in the path, and the surface is almost entirely read plus file upload, so you can scope an agent to reading documents on specific projects while withholding uploads.

### Can the API upload files?

Yes, through a chunked upload flow: create an upload slot, send the parts, then finalize the upload so the file lands in the chosen file area.

### Does Dalux Field cover drawings and documents?

Yes. File areas, folders, files, and version sets hold the project's documents and drawings, and the API can retrieve file content and revision history.

### What is TryBuildAPI?

TryBuildAPI is the title of the Dalux Field OpenAPI spec; it is the same interface described here for reading Dalux Field project data and uploading files.