### Autodesk Webhook Payload Example
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This is an example of a webhook payload sent by Autodesk. It provides information about the event that triggered the webhook, the resource involved, and the associated data. This payload can be used to process the event in your application.
```json
{
"version": "1.0",
"resourceUrn": "urn:adsk.wipprod:dm.lineage:abc123",
"hook": {
"hookId": "e6c3b0e4-23e5-4df2-93f4-7d8a9b6c5d4e",
"tenant": "your-tenant-id",
"callbackUrl": "https://myapp.example.com/webhooks/autodesk",
"createdBy": "your-user-id",
"event": "dm.version.added",
"createdDate": "2025-10-13T10:30:00.000Z",
"system": "data",
"creatorType": "Application",
"status": "active",
"scope": {
"folder": "urn:adsk.wipprod:fs.folder:co.abc123xyz"
}
},
"payload": {
"version": 1,
"type": "version",
"id": "urn:adsk.wipprod:fs.file:vf.abc123xyz?version=1"
}
}
```
--------------------------------
### POST /webhooks/autodesk
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Endpoint for receiving webhooks from Autodesk services. This example demonstrates payload structure and verification.
```APIDOC
## POST /webhooks/autodesk
### Description
Receives webhook notifications from Autodesk services for specific events. Includes example payload and Node.js code for signature verification.
### Method
POST
### Endpoint
https://myapp.example.com/webhooks/autodesk
### Request Body
- **version** (string) - The version of the webhook payload.
- **resourceUrn** (string) - The URN of the affected resource.
- **hook** (object) - Details about the webhook subscription.
- **hookId** (string) - The unique identifier for the webhook.
- **tenant** (string) - The tenant ID.
- **callbackUrl** (string) - The URL where the webhook is sent.
- **createdBy** (string) - The user or application that created the webhook.
- **event** (string) - The event that triggered the webhook.
- **createdDate** (string) - The date and time the webhook was created.
- **system** (string) - The system that generated the event.
- **creatorType** (string) - The type of creator (e.g., Application).
- **status** (string) - The status of the webhook (e.g., active).
- **scope** (object) - The scope of the webhook.
- **folder** (string) - The URN of the folder.
- **payload** (object) - The actual data related to the event.
- **version** (integer) - The version of the payload.
- **type** (string) - The type of payload.
- **id** (string) - The identifier of the payload resource.
### Request Example
```json
{
"version": "1.0",
"resourceUrn": "urn:adsk:wipprod:dm.lineage:abc123",
"hook": {
"hookId": "e6c3b0e4-23e5-4df2-93f4-7d8a9b6c5d4e",
"tenant": "your-tenant-id",
"callbackUrl": "https://myapp.example.com/webhooks/autodesk",
"createdBy": "your-user-id",
"event": "dm.version.added",
"createdDate": "2025-10-13T10:30:00.000Z",
"system": "data",
"creatorType": "Application",
"status": "active",
"scope": {
"folder": "urn:adsk.wipprod:fs.folder:co.abc123xyz"
}
},
"payload": {
"version": 1,
"type": "version",
"id": "urn:adsk.wipprod:fs.file:vf.abc123xyz?version=1"
}
}
```
### Response
(Typically a 200 OK for acknowledgement)
### Signature Verification (Node.js)
```javascript
const crypto = require('crypto');
function verifyWebhookSignature(payload, signature, secret) {
const hmac = crypto.createHmac('sha256', secret);
hmac.update(JSON.stringify(payload));
const expectedSignature = hmac.digest('hex');
return signature === expectedSignature;
}
```
```
--------------------------------
### Load and Use Data Visualization SDK with Viewer
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Loads the Data Visualization extension for the Autodesk Viewer and demonstrates how to set up and render custom data visualizations. It includes examples for creating sprite markers and surface heatmaps, defining styles, and updating data dynamically. Requires the Viewer SDK and DataVisualization extension scripts.
```html
```
--------------------------------
### Get Assets via Autodesk Construction API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves assets (equipment tracking) for a given project. Requires a project ID and an authorization token. Returns asset data.
```shell
curl -X GET "https://developer.api.autodesk.com/construction/assets/v1/projects/PROJECT_ID/assets" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Parameter Definition (Parameters API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the definition of a specific parameter by its ID using a GET request to the Autodesk Parameters API. Requires an authorization token.
```bash
curl -X GET https://developer.api.autodesk.com/parameters/v1/parameters/param-abc123 \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Assets (Equipment Tracking)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of assets (equipment) for a specific project, typically used for equipment tracking.
```APIDOC
## Get Assets (Equipment Tracking)
### Description
Retrieves a list of assets (equipment) for a specific project, typically used for equipment tracking.
### Method
GET
### Endpoint
`/construction/assets/v1/projects/{PROJECT_ID}/assets`
### Parameters
#### Path Parameters
- **PROJECT_ID** (string) - Required - The ID of the project for which to retrieve assets.
#### Query Parameters
None
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/construction/assets/v1/projects/PROJECT_ID/assets" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **assets** (array) - A list of asset objects.
#### Response Example
(Structure not provided in source text)
```
--------------------------------
### Get Object Tree Properties using Model Derivative API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This bash command retrieves the object tree properties for a specific model using the Model Derivative API. It requires the base64 encoded URN and the GUID of the model, along with an access token. This data is essential for navigating and understanding the model's structure.
```bash
# Step 4: Get object tree
curl -X GET "https://developer.api.autodesk.com/modelderivative/v2/designdata/BASE64_ENCODED_URN/metadata/GUID/properties" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get RFIs via Autodesk Construction API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of Requests for Information (RFIs) for a given project. Requires a project ID and an authorization token. Returns RFI data.
```shell
curl -X GET "https://developer.api.autodesk.com/construction/rfis/v1/projects/PROJECT_ID/rfis" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Account Projects
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of projects associated with a specific Autodesk Construction Cloud (ACC) account.
```APIDOC
## Get Account Projects
### Description
Retrieves a list of projects associated with a specific Autodesk Construction Cloud (ACC) account.
### Method
GET
### Endpoint
`/hq/v1/accounts/{ACCOUNT_ID}/projects`
### Parameters
#### Path Parameters
- **ACCOUNT_ID** (string) - Required - The unique identifier of the ACC account.
#### Query Parameters
None
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/hq/v1/accounts/ACCOUNT_ID/projects" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **projects** (array) - A list of project objects.
- **id** (string) - The project ID.
- **name** (string) - The project name.
#### Response Example
(Structure not provided in source text)
```
--------------------------------
### Get Facility Model
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the model information for a specific facility.
```APIDOC
## GET /tandem/v1/twins/:TWIN_ID/models
### Description
Retrieves the model information for a specific facility.
### Method
GET
### Endpoint
`/tandem/v1/twins/TWIN_ID/models`
### Parameters
#### Path Parameters
- **TWIN_ID** (string) - Required - The ID of the facility (digital twin).
### Request Example
```bash
curl -X GET https://developer.api.autodesk.com/tandem/v1/twins/twin-abc123/models \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **results** (array) - Contains information about the facility's models.
#### Response Example
(Example response structure not provided in the source text, but would typically list model details.)
```
--------------------------------
### Embed Interactive 3D Model Viewer with APS Viewer SDK (HTML/JavaScript)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Integrates an interactive 2D/3D model viewer into web applications using the APS Viewer SDK. This example demonstrates initialization, loading models, and basic viewer interactions like selection, property inspection, fitting to view, setting background color, isolating objects, and searching. It requires an access token obtained from a server-side endpoint.
```html
APS Viewer Example
```
--------------------------------
### Get Account Projects via Autodesk HQ API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of projects associated with a specific account ID. Requires an account ID and an authorization token. Returns project data.
```shell
curl -X GET "https://developer.api.autodesk.com/hq/v1/accounts/ACCOUNT_ID/projects" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Cost Items
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of cost items within a project container.
```APIDOC
## Get Cost Items
### Description
Retrieves a list of cost items within a project container. Cost items are typically used for budgeting, estimating, and tracking project expenses.
### Method
GET
### Endpoint
`/cost/v1/containers/{PROJECT_CONTAINER_ID}/cost-items`
### Parameters
#### Path Parameters
- **PROJECT_CONTAINER_ID** (string) - Required - The ID of the project container.
#### Query Parameters
None
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/cost/v1/containers/PROJECT_CONTAINER_ID/cost-items" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **cost_items** (array) - A list of cost item objects.
#### Response Example
(Structure not provided in source text)
```
--------------------------------
### Search Parameters by Label (Parameters API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Finds parameters based on specified labels and disciplines using a GET request to the Autodesk Parameters API. Query parameters are used to filter the search results.
```bash
curl -X GET "https://developer.api.autodesk.com/parameters/v1/parameters?filter[label]=structural&filter[discipline]=Engineering" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Automation API Workitem Response
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Example of a JSON response from the Autodesk Automation API after submitting a workitem. It shows the workitem's ID, status, and relevant timestamps.
```json
{
"id": "5f8d9c6e3a2b1f0012345678",
"status": "pending",
"stats": {
"timeQueued": "2025-10-13T10:35:00.000Z"
}
}
```
--------------------------------
### Get Bill of Materials (MDM API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the bill of materials (BOM) for a given CAD file using the Manufacturing Data Model API. The BOM includes item details such as part number, description, quantity, and material.
```bash
curl -X GET "https://developer.api.autodesk.com/mdm/v1/projects/PROJECT_ID/files/FILE_ID/bom" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Model Derivative API - Get Object Tree
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieve the object tree (hierarchical structure) of a translated model. This GET request is made to the /modelderivative/v2/designdata/{BASE64_ENCODED_URN}/metadata/{GUID}/properties endpoint.
```APIDOC
## GET /modelderivative/v2/designdata/:urn/metadata/:guid/properties
### Description
Retrieves the object tree (hierarchical structure) and properties of a specific part of the translated model.
### Method
GET
### Endpoint
https://developer.api.autodesk.com/modelderivative/v2/designdata/{BASE64_ENCODED_URN}/metadata/{GUID}/properties
### Parameters
#### Path Parameters
- **urn** (string) - Required - The base64 encoded URN of the object.
- **guid** (string) - Required - The GUID of the specific metadata entry for which to retrieve the object tree.
#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication.
### Response
#### Success Response (200)
(Response body structure for object tree and properties can be complex and vary based on the input model. It typically includes nested objects representing the hierarchy and their associated properties.)
#### Response Example
(Example response structure would be highly dependent on the specific model and its properties. This is a placeholder.)
```json
{
"example": "Response body containing the object tree and properties"
}
```
```
--------------------------------
### Get RFIs
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves a list of Requests for Information (RFIs) for a specific project.
```APIDOC
## Get RFIs (Requests for Information)
### Description
Retrieves a list of Requests for Information (RFIs) for a specific project.
### Method
GET
### Endpoint
`/construction/rfis/v1/projects/{PROJECT_ID}/rfis`
### Parameters
#### Path Parameters
- **PROJECT_ID** (string) - Required - The ID of the project for which to retrieve RFIs.
#### Query Parameters
None
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/construction/rfis/v1/projects/PROJECT_ID/rfis" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **rfis** (array) - A list of RFI objects.
#### Response Example
(Structure not provided in source text)
```
--------------------------------
### Get Tandem Facility Model
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Fetches the model information for a specific digital twin facility. Requires a Twin ID and an Access Token.
```bash
curl -X GET https://developer.api.autodesk.com/tandem/v1/twins/twin-abc123/models \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Model Structure (MDM API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the hierarchical structure of a CAD model, including its components and their properties, using the Manufacturing Data Model API. This requires project and file IDs.
```bash
curl -X GET "https://developer.api.autodesk.com/mdm/v1/projects/PROJECT_ID/files/FILE_ID" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Element Properties with Relationships
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves detailed properties and relationships for a specific element.
```APIDOC
## GET /projects/:PROJECT_ID/models/:MODEL_ID/elements/:ELEMENT_ID
### Description
Retrieves detailed properties and relationships for a specific element.
### Method
GET
### Endpoint
`/projects/PROJECT_ID/models/MODEL_ID/elements/ELEMENT_ID`
### Parameters
#### Path Parameters
- **PROJECT_ID** (string) - Required - The ID of the project.
- **MODEL_ID** (string) - Required - The ID of the model.
- **ELEMENT_ID** (string) - Required - The ID of the element.
#### Query Parameters
- **include** (string) - Optional - Specifies related data to include (e.g., "relationships").
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/aec/v1/projects/PROJECT_ID/models/MODEL_ID/elements/element-wall-001?include=relationships" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **data** (object) - Contains the element's ID, type, attributes, and relationships.
- **included** (array) - Contains additional included data, such as related elements.
#### Response Example
```json
{
"data": {
"id": "element-wall-001",
"type": "elements",
"attributes": {
"name": "Basic Wall: Exterior - 300mm",
"category": "Walls"
},
"relationships": {
"hostedElements": {
"data": [
{"type": "elements", "id": "element-door-042"},
{"type": "elements", "id": "element-window-113"}
]
},
"level": {
"data": {"type": "levels", "id": "level-1"}
}
}
},
"included": [{
"id": "element-door-042",
"type": "elements",
"attributes": {
"name": "Single Door: 900mm x 2100mm",
"category": "Doors"
}
}]
}
```
```
--------------------------------
### Manage Design Files with APS Data Management API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This snippet shows how to interact with design files, folders, and versions stored in Autodesk cloud storage (BIM 360, ACC, Fusion Team) using the Data Management API. It includes examples for listing hubs, projects, folders, and uploading files to Object Storage Service (OSS).
```bash
# List hubs (top-level containers)
curl -X GET https://developer.api.autodesk.com/project/v1/hubs \
-H "Authorization: Bearer ACCESS_TOKEN"
# Response
{
"data": [{
"type": "hubs",
"id": "b.a4be0c34-4ab7-4d63-b6b4-3e8f1e2c6f9b",
"attributes": {
"name": "My Company Hub",
"extension": {
"type": "hubs:autodesk.bim360:Account",
"version": "1.0"
}
}
}]
}
# List projects in a hub
curl -X GET https://developer.api.autodesk.com/project/v1/hubs/b.a4be0c34-4ab7-4d63-b6b4-3e8f1e2c6f9b/projects \
-H "Authorization: Bearer ACCESS_TOKEN"
# Get project top folders
curl -X GET "https://developer.api.autodesk.com/project/v1/hubs/HUB_ID/projects/PROJECT_ID/topFolders" \
-H "Authorization: Bearer ACCESS_TOKEN"
# List folder contents
curl -X GET "https://developer.api.autodesk.com/data/v1/projects/PROJECT_ID/folders/FOLDER_ID/contents" \
-H "Authorization: Bearer ACCESS_TOKEN"
# Upload file to OSS (Object Storage Service)
# Step 1: Create bucket
curl -X POST https://developer.api.autodesk.com/oss/v2/buckets \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"bucketKey": "my-unique-bucket-key-2025",
"policyKey": "transient"
}'
# Step 2: Upload object to bucket
curl -X PUT "https://developer.api.autodesk.com/oss/v2/buckets/my-unique-bucket-key-2025/objects/mymodel.rvt" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/octet-stream" \
--data-binary '@/path/to/mymodel.rvt'
```
--------------------------------
### Get Cost Items via Autodesk Cost API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves cost items for a specific project container. Requires a project container ID and an authorization token. Returns cost item data.
```shell
curl -X GET "https://developer.api.autodesk.com/cost/v1/containers/PROJECT_CONTAINER_ID/cost-items" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Model Structure
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the structure of a specific model within a project.
```APIDOC
## GET /projects/:PROJECT_ID/models/:MODEL_ID
### Description
Retrieves the structure of a specific model within a project.
### Method
GET
### Endpoint
`/projects/PROJECT_ID/models/MODEL_ID`
### Parameters
#### Path Parameters
- **PROJECT_ID** (string) - Required - The ID of the project.
- **MODEL_ID** (string) - Required - The ID of the model.
### Request Example
```bash
curl -X GET "https://developer.api.autodesk.com/aec/v1/projects/PROJECT_ID/models/MODEL_ID" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **data** (array) - Contains model elements and their attributes.
- **pagination** (object) - Contains pagination information for the results.
#### Response Example
```json
{
"data": [{
"id": "element-wall-001",
"type": "elements",
"attributes": {
"name": "Basic Wall: Exterior - 300mm",
"category": "Walls",
"level": "Level 1",
"properties": {
"Height": 3000,
"Length": 5000,
"Width": 300,
"Volume": 4.5,
"Area": 15.0,
"Fire Rating": "2HR",
"Structural": true
}
}
}],
"pagination": {
"limit": 100,
"offset": 0,
"totalResults": 247
}
}
```
```
--------------------------------
### Automation API Workitem Completed Response
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Example of a JSON response from the Autodesk Automation API after a workitem has completed. It shows the workitem's ID, status, timestamps, and the URL to the report file.
```json
{
"id": "5f8d9c6e3a2b1f0012345678",
"status": "success",
"stats": {
"timeQueued": "2025-10-13T10:35:00.000Z",
"timeDownloadStarted": "2025-10-13T10:35:05.000Z",
"timeInstructionsStarted": "2025-10-13T10:35:10.000Z",
"timeInstructionsEnded": "2025-10-13T10:36:45.000Z",
"timeUploadEnded": "2025-10-13T10:36:50.000Z"
},
"reportUrl": "https://dasprod-store.s3.amazonaws.com/workitem-5f8d9c6e3a2b1f0012345678/report.txt?AWSAccessKeyId=..."
}
```
--------------------------------
### Get AEC Element Properties with Relationships
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Fetches detailed properties and relationships for a specific element, including hosted elements and its level. Requires Project ID, Model ID, Element ID, and an Access Token.
```bash
curl -X GET "https://developer.api.autodesk.com/aec/v1/projects/PROJECT_ID/models/MODEL_ID/elements/element-wall-001?include=relationships" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get Features (MDM API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Fetches the geometric features of a specific component within a CAD file using the Manufacturing Data Model API. This includes feature types and their parameters.
```bash
curl -X GET "https://developer.api.autodesk.com/mdm/v1/projects/PROJECT_ID/files/FILE_ID/components/comp-001/features" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Get AEC Model Structure
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves the structural information of a model within a specific project. Requires a Project ID, Model ID, and an Access Token for authentication.
```bash
curl -X GET "https://developer.api.autodesk.com/aec/v1/projects/PROJECT_ID/models/MODEL_ID" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Model Derivative API - Extract Metadata
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Extract metadata information for a translated object. This GET request is made to the /modelderivative/v2/designdata/{BASE64_ENCODED_URN}/metadata endpoint.
```APIDOC
## GET /modelderivative/v2/designdata/:urn/metadata
### Description
Retrieves metadata about the translated object, including its name, GUID, role, and status.
### Method
GET
### Endpoint
https://developer.api.autodesk.com/modelderivative/v2/designdata/{BASE64_ENCODED_URN}/metadata
### Parameters
#### Path Parameters
- **urn** (string) - Required - The base64 encoded URN of the object.
#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication.
### Response
#### Success Response (200)
- **data** (object) - The main data object.
- **type** (string) - The type of the metadata response.
- **metadata** (array) - An array of metadata objects.
- **name** (string) - The name of the metadata entry.
- **guid** (string) - The unique identifier (GUID) for the metadata.
- **role** (string) - The role of the metadata (e.g., `3d`).
- **status** (string) - The status of the metadata extraction.
#### Response Example
```json
{
"data": {
"type": "metadata",
"metadata": [
{
"name": "mymodel",
"guid": "d1c5f96f-15e4-42e8-8c6e-3f8d5c95b0f5",
"role": "3d",
"status": "success"
}
]
}
}
```
```
--------------------------------
### Model Derivative API - Check Translation Status
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieve the current status of a translation job using its base64 encoded URN. This GET request is made to the /modelderivative/v2/designdata/{BASE64_ENCODED_URN}/manifest endpoint.
```APIDOC
## GET /modelderivative/v2/designdata/:urn/manifest
### Description
Checks the status and progress of a previously submitted translation job.
### Method
GET
### Endpoint
https://developer.api.autodesk.com/modelderivative/v2/designdata/{BASE64_ENCODED_URN}/manifest
### Parameters
#### Path Parameters
- **urn** (string) - Required - The base64 encoded URN of the object.
#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication.
### Response
#### Success Response (200)
- **type** (string) - The type of the manifest.
- **hasThumbnail** (string) - Indicates if a thumbnail is available ('true' or 'false').
- **status** (string) - The overall status of the translation (e.g., `inprogress`, `success`, `failed`).
- **progress** (string) - The completion progress of the translation (e.g., `complete`, `25% complete`).
- **region** (string) - The region where the object is stored.
- **urn** (string) - The base64 encoded URN of the object.
- **derivatives** (array) - An array of derivative objects, each representing a translated format.
- **name** (string) - The name of the derivative file.
- **hasThumbnail** (string) - Indicates if the derivative has a thumbnail.
- **status** (string) - The status of the specific derivative.
- **progress** (string) - The progress of the specific derivative.
- **outputType** (string) - The output type of the derivative (e.g., `svf2`).
#### Response Example (in progress)
```json
{
"type": "manifest",
"hasThumbnail": "true",
"status": "inprogress",
"progress": "complete",
"region": "US",
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bXktdW5pcXVlLWJ1Y2tldC1rZXktMjAyNS9teW1vZGVsLnJ2dA==",
"derivatives": [
{
"name": "mymodel.rvt",
"hasThumbnail": "true",
"status": "inprogress",
"progress": "25% complete",
"outputType": "svf2"
}
]
}
```
```
--------------------------------
### Query Tandem Historical Sensor Data
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Retrieves historical sensor data for a specific stream within a given time range. Requires a Twin ID, stream key, start and end timestamps, and an Access Token.
```bash
curl -X GET "https://developer.api.autodesk.com/tandem/v1/twins/twin-abc123/streams/ahu-001-supply-temp/data?from=2025-10-13T00:00:00.000Z&to=2025-10-13T23:59:59.000Z" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Extract Metadata using Model Derivative API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This code snippet shows how to extract metadata from a translated model using the Model Derivative API. It requires the base64 encoded URN of the model and an access token. The response contains information about the model, including its GUID, role, and status.
```bash
# Step 3: Extract metadata
curl -X GET "https://developer.api.autodesk.com/modelderivative/v2/designdata/BASE64_ENCODED_URN/metadata" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
--------------------------------
### Create App Bundle using Autodesk Automation API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This cURL command creates an app bundle in the Autodesk Automation API. The app bundle contains your script and defines the engine it uses. The response provides a signed URL for uploading the app bundle zip file.
```bash
curl -X POST https://developer.api.autodesk.com/da/us-east/v3/appbundles \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "MyRevitPlugin",
"engine": "Autodesk.Revit+2025",
"description": "Automates wall parameter updates"
}'
```
--------------------------------
### Create Activity using Autodesk Automation API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
This cURL command creates an activity in the Autodesk Automation API. An activity defines what the script does, including the command line arguments, input/output parameters, and the engine and app bundle to use. Requires a previously created app bundle.
```bash
curl -X POST https://developer.api.autodesk.com/da/us-east/v3/activities \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "UpdateWallsActivity",
"commandLine": ["$(engine.path)\revitcoreconsole.exe /i \"$(args[inputFile].path)\" /al \"$(appbundles[MyRevitPlugin].path)\""]
"parameters": {
"inputFile": {
"verb": "get",
"description": "Input Revit model",
"required": true,
"localName": "input.rvt"
},
"outputFile": {
"verb": "put",
"description": "Output Revit model",
"required": true,
"localName": "output.rvt"
},
"configData": {
"verb": "get",
"description": "JSON configuration",
"required": false,
"localName": "config.json"
}
},
"engine": "Autodesk.Revit+2025",
"appbundles": ["MyRevitPlugin+dev"]
}'
```
--------------------------------
### Create Submittal via Autodesk Construction API
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Creates a new submittal for a project. Requires a project ID, authorization token, and a JSON payload with submittal details. Returns the created submittal's data.
```shell
curl -X POST "https://developer.api.autodesk.com/construction/submittals/v1/projects/PROJECT_ID/submittals" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Steel Beam Specifications",
"description": "Shop drawings for structural steel Level 5-8",
"submittal_type": "shop_drawing",
"due_date": "2025-10-25T00:00:00.000Z",
"received_from": "Steel Fabricator Inc.",
"spec_section": "05 12 00"
}'
```
--------------------------------
### List Facilities
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Lists all facilities (digital twins) available in the Tandem system.
```APIDOC
## GET /tandem/v1/twins
### Description
Lists all facilities (digital twins) available in the Tandem system.
### Method
GET
### Endpoint
`/tandem/v1/twins`
### Parameters
None
### Request Example
```bash
curl -X GET https://developer.api.autodesk.com/tandem/v1/twins \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### Response
#### Success Response (200)
- **results** (array) - A list of facilities, each with its ID, name, creation date, and settings.
#### Response Example
```json
{
"results": [{
"twinId": "twin-abc123",
"name": "Corporate Headquarters Building A",
"createdAt": "2025-01-15T09:00:00.000Z",
"settings": {
"units": "metric"
}
}]
}
```
```
--------------------------------
### Create Parameter Definition (Parameters API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Demonstrates how to create a new parameter definition in the Autodesk Parameters API. This involves sending a POST request with a JSON payload specifying the parameter's properties.
```bash
curl -X POST https://developer.api.autodesk.com/parameters/v1/parameters \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "FireRating",
"description": "Fire resistance rating in hours",
"dataType": "number",
"unit": "hours",
"defaultValue": 1,
"allowedValues": [0.5, 1, 2, 3, 4],
"discipline": "Architectural",
"category": "Materials"
}'
```
--------------------------------
### Create Collection (Parameters API)
Source: https://context7.com/context7/aps_autodesk_developer/llms.txt
Shows how to create a new collection to group related parameters using the Autodesk Parameters API. A POST request with a JSON body containing the collection's name, description, and a list of parameter IDs is used.
```bash
curl -X POST https://developer.api.autodesk.com/parameters/v1/collections \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Building Code Parameters",
"description": "Required parameters for code compliance",
"parameters": ["param-abc123", "param-def456", "param-ghi789"]
}'
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.