> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://knowledge.buildagil.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Buildagil openCDE API


The buildagil openCDE API enables developers to interact seamlessly 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](https://www.buildingsmart.org/) (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 is intended for developers or individuals with programming skills.

**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 via 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](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow).

**Surroundings**
The buildagil openCDE API is available exclusively in the production environment. The same environment is used for development and testing purposes.

**Options**
The buildagil openCDE API offers the following capabilities, among others:
* View project information
* View, create, and update tasks and topics
* Retrieve, upload, move, and update documents 
* Retrieve document versions
* Retrieve and update document metadata
* View meetings
* View Milestones
* Retrieve user
* Respond to the creation of tasks and topics, documents, meetings, milestones, and users
* Respond to changes in tasks and topics, documents, meetings, and milestones

| You can find the documentation for the buildagil openCDE API at the following link: [Buildagil openCDE API Documentation](https://app.swaggerhub.com/apis-docs/buildagil/openCDE-API/1.0?view=elementsDocs)

**Deep Linking**
It is possible to create deep links that provide direct access to specific content within buildagil.
Example: https://app.buildagil.com/open?guid=xxx

**Rate Limits**
The buildagil openCDE API uses user-based, dynamic rate limiting. During periods of high usage, access may be throttled on a per-user basis. It is recommended that you schedule resource-intensive actions (such as retrieving or uploading large amounts of data) during off-peak hours.

> openCDE, 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