Task 4 - Create an Output
Key learnings
By the end of this task, you will be able to:
- Create Outputs
- Retrieve the created Output
The operations used in this task are as follows:
| Operation | HTTP Request | Description |
|---|---|---|
| Create Outputs | POST /outputs | Creates Outputs of a Variant. |
| Get an Output Request | GET /outputsrequest/{outputsRequestId} | Returns the details of an output request. |
| Get an Output | GET /outputs/{outputId} | Returns the details of a single output of a variant. |
Step 1: Create Outputs
Now that we have created a Variant, we can create outputs for this Variant. Below, we create RFA, BOM, and THUMBNAIL outputs for the Variant.
Request
curl -L -X \
POST 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{TOKEN}}' \
-d '{
"variantId": "{{VARIANT_ID}}",
"onComplete": {
"verb": "POST",
"url": "https://ind-api.free.beeceptor.com/oncomplete"
},
"onProgress": {
"verb": "POST",
"url": "https://ind-api.free.beeceptor.com/onprogress"
},
"outputs": [
{
"type": "RFA",
"settings": {
"representation": "[Primary]"
}
},
{
"type": "BOM",
"settings": {
"representation": "[Primary]"
}
},
{
"type": "THUMBNAIL",
"settings": {
"representation": "[Primary]"
}
}
]
}'
Show More
Response
Returns a JSON response with status 201
{
"accessType": "{{ACCESS_TYPE}}",
"accessId": "{{ACCESS_ID}}",
"productId": "{{PRODUCT_ID}}",
"releaseId": "{{RELEASE_ID}}",
"outputsRequestId": "{{OUTPUTS_REQUEST_ID}}",
"status": "PENDING",
"createdAt": "2025-04-28T15:00:46.386Z",
"updatedAt": "2025-04-28T15:00:46.386Z",
"outputs": [
{
"settings": {
"representation": "[Primary]",
"version": "2025",
"category": "Generic Models",
"family": "Wall-100"
},
"accessType": "...",
"accessId": "...",
"id": "...",
"variantId": "...",
"status": "PENDING",
"createdAt": "2025-04-28T15:00:45.529Z",
"updatedAt": "2025-04-28T15:00:45.529Z",
"type": "RFA"
},
{
"settings": {
"representation": "[Primary]"
},
"accessType": "...",
"accessId": "...",
"id": "...",
"variantId": "...",
"status": "PENDING",
"createdAt": "2025-04-28T15:00:45.529Z",
"updatedAt": "2025-04-28T15:00:45.529Z",
"type": "BOM"
},
{
"settings": {
"representation": "[Primary]"
},
"accessType": "...",
"accessId": "...",
"id": "...",
"variantId": "...",
"status": "PENDING",
"createdAt": "2025-04-28T15:00:45.529Z",
"updatedAt": "2025-04-28T15:00:45.529Z",
"type": "THUMBNAIL"
}
]
}
Show More
Step 2: Retrieve the Output Request
Using the Output Request ID you received when creating the Outputs, you can retrieve the Output Request. The response of the Output Request contains a short lived URL for the log file. The contents of the log file are logs of the Output generation process.
Request
curl -L -X GET \
'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputsrequest/{{OUTPUT_REQUEST_ID}}?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Authorization: Bearer {{TOKEN}}'
Response
Returns a JSON response with status 200 if found
{
"id": "{{OUTPUT_REQUEST_ID}}",
"accessType": "{{ACCESS_TYPE}}",
"accessId": "{{ACCESS_ID}}",
"outputs": [
{
"status": "SUCCESS",
"id": "9a9b4b8f-9dbb-4513-a0e4-4344873269b0"
},
{
"status": "SUCCESS",
"id": "df6210f3-6301-4a83-8f6e-0e05f23ca368"
},
{
"status": "SUCCESS",
"id": "623d9ce6-6f23-473d-9985-91e4ba3f7a4d"
}
],
"onComplete": {
"url": "https://ind-api.free.beeceptor.com/oncomplete",
"verb": "POST"
},
"onProgress": {
"url": "https://ind-api.free.beeceptor.com/onprogress",
"verb": "POST"
},
"logFile": "https://s3.amazonaws.com/com.autodesk.oss-persistent/22/a7/9f/891093066ddf8d20ec9fa2bfacb78ccad2/mid-data?response-content-disposition=attachment%3B%20filename%3D%22outputsRequest_log.txt%22&response-content-type=text%2Fplain&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIGT%2B1thmWK8%2F%2BhX%2FbX6Iqw9Mq9XCwE5%2FUC3ZOOUkXCeQAiB4N3oAHKNfBXPcsjhAHScVDuCKnZBKXADpbqQSXZn6liq4Agh4EAAaDDYwNDczMzAwOTQwMyIM2j4ya%2FgxB11OFYpnKpUC4X15CStVdvmKsOoHCTKlhkkRvurkK4QmBuwUdVO585UmsKV8XOAd%2BZprM5B%2B0eIDAi3Ju6v6iUeLvoNhTGkjqwqfBDU4knL1w%2F%2B75alxGXnXs701Qf5QrN067Q31iFuzUL7sqNVA6vtRfAeOwAan2OV3zvQvfqs7ztHzJP3ACWP9s8zS1Lvm5ralg0T%2BenHmmpsXZIxB60lNGX8%2BBCbOq2zyAv%2BunD385LNVQ5EBOy4Vqp0k%2BgUTf2TwsumGUUjkJ1y4PNpfLDADJGlq1pct5jjmbQGHU1mwvuzSYEzLuoOXXn7V8uzSH8y%2FI4ww4x6J5mb8EnyktH7b5uSwwPCS%2B8k0GMsbDDePTMhbOn4VYp3Rqb34xjDCr77ABjqeAS2tSG2T7ytRucdarEqKfsHlRcyLrYRSpbqqMi2AoagIZo075URIkgY1Pop57WSbropQBXXe744%2F2QK9hT%2BLByDcY%2FOHEsSXw%2Fiwq9%2B%2BY20bcA8QyiArVSh7WuaTAt69EGIvBwsFqFL6SWCPb1HV8sfvJZIN%2FjoDV4wh6RegvLXvl59AgVOFFWCEj6zHBW8B4xm86HC5i2jZgLgUM6od&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250428T150445Z&X-Amz-SignedHeaders=host&X-Amz-Credential=ASIAYZTHFNX52HN7SEW4%2F20250428%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=119&X-Amz-Signature=7846e0166d0cfb0e03b7315f4519106d827cd0927633bb1e1fa620c428f600e3",
"status": "SUCCESS",
"createdAt": "2025-04-28T15:00:46.386Z",
"updatedAt": "2025-04-28T15:02:59.677Z"
}
Show More
Step 3: Retrieve a single Output
Using one of the id of the output in the response from the output request, you can retrieve the output.
Request
curl -L -X GET \
'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs/{{OUTPUT_ID}}?accessType={{ACCESS-TYPE}}&accessId={{ACCESS_ID)' \
-H 'Authorization: Bearer {{TOKEN}}'
Response
Returns a JSON response with status 200 if found
{
"settings": {
"representation": "[Primary]",
"version": "2025",
"category": "Generic Models",
"family": "Wall-100"
},
"accessType": "{{ACCESS_TYPE}}",
"accessId": "{{ACCESS_ID}}",
"id": "{{OUTPUT_ID}}",
"variantId": "{{VARIANT_ID}}",
"status": "SUCCESS",
"createdAt": "2025-04-28T15:00:45.529Z",
"updatedAt": "2025-04-28T15:02:57.626Z",
"type": "RFA"
}
Show More