Buildagil openCDE API
Options
The buildagil openCDE API enables seamless interaction with buildagil and offers numerous roles and tools to facilitate data exchange and integration with existing systems. It is based on the openCDE API specification from BuildingSMART (BCF API / Documents API) and has been expanded to include additional endpoints, capabilities, and fields to provide greater flexibility and functionality.
The buildagil openCDE API offers the following capabilities, among others:
- Search for content
- View, create, and edit personal tasks
- View project information
- View, create, and edit tasks and topics
- Retrieve, upload, move, and edit documents
- Retrieve document versions
- Retrieve and modify document metadata
- View meetings
- View milestones
- Retrieve users
- Respond to the creation of tasks and topics, documents, meetings, milestones, and users
- Respond to changes in tasks and topics, documents, meetings, and milestones
Authentication
To authenticate with the buildagil openCDE API, please contact support and provide a callback URL to receive your client ID and client secret. These credentials are required to authenticate with the buildagil openCDE API.
Authentication is based on the Microsoft Identity Platform and is performed using the OAuth 2.0 authorization code flow with user-based login. Each login is associated with a single user. For more information on the Authorization Code Flow, see the following article: Microsoft Identity Platform and the OAuth 2.0 authorization code flow.
Visibility & Permissions
The same visibility settings and permissions apply to retrieving and modifying content via the buildagil openCDE API as they do elsewhere on buildagil. Details can be found at Visibility & Permissions.
Surroundings
Only a production environment is available for the buildagil openCDE API.
Rate Limits
The buildagil openCDE API uses user-based, dynamic rate limiting. During periods of high usage, user-based throttling may occur. It is recommended that you schedule resource-intensive actions (such as retrieving or uploading large amounts of data) during off-peak hours.
Deep Linking
To open content directly on buildagil or link to it, you can use the "link" property in the corresponding response.
Terms of Use
The API is made available for the purposes described above in accordance with the fair use principle. Individual roles, data structures, endpoints, and technical or usage-related restrictions may be adjusted or changed as part of ongoing development. Planned and implemented changes will be published in the News & Updates.
API users are responsible for securely storing their access credentials and tokens, as well as for using the API properly. Security mechanisms, access restrictions, and rate limits must not be circumvented. Users are also responsible for appropriately verifying the data received via the API. They are further responsible for all actions triggered via the API, regardless of whether these are triggered directly, automatically, or by third-party applications, including AI agents.
In addition, the General Terms of Use for buildagil apply.
openCDE, OpenAPI, API, BCF API, OAuth 2.0, Authorization Code Flow, Microsoft Identity Platform, User-Based Sign-In, Client ID, Client Secret, Production Environment, Test Environment, API Authentication
Updated on: 28/10/2026