Developer hubs
Sign in
Request
Response
Model Derivative API
Model Derivative API
Version 2
Developer's Guide
Overview
API Basics
About this API
Translate Models
Prepare Models for Online Viewing
Extract Metadata
Extract Geometry
Generate Thumbnails
GDPR Compliance
Webhooks
Field Guide
Supported Translations
Rate Limits
APS Rate Limits and Quotas
Model Derivative Rate Limits
How-to Guide
Translate a Source File
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate Source File
Task 4 - Download OBJ File
Translate a Source File Packaged as a Zip File
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate Source File
Task 4 - Download STL File
Translate a Source File that Contains References
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source Files to OSS
Task 3 - Translate Source File
Task 4 - Download STL File
Prepare a File for the Viewer
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate to SVF2
Task 4 - Display Model in the Viewer
Extract Metadata From a Source File
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate to SVF2
Task 4 - Extract Metadata
Extract Geometry From a Source File
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate to SVF2
Task 4 - Extract Metadata
Task 5 - Extract Geometry
Translate a Revit File, Generating Room and Space Information
About this Walkthrough
Task 1 - Obtain an Access Token
Task 2 - Upload Source File to OSS
Task 3 - Translate to SVF2
Task 4 - Display Model in the Viewer
Code Samples
Code Samples
Reference Guide
REST API Reference
Informational
GET List Supported Formats
Jobs
POST Create Translation Job
POST Specify References
Manifest
GET Fetch Manifest
DELETE Delete Manifest
Derivatives
GET Fetch Derivative Download URL
GET Download Derivative (Deprecated)
HEAD Check Derivative Details
Thumbnails
GET Fetch Thumbnail
Metadata
GET List Model Views
GET Fetch Object Tree
GET Fetch All Properties
POST Fetch Specific Properties
.NET SDK Reference
Autodesk.ModelDerivative Namespace
ModelDerivativeApiException Class
ModelDerivativeClient Class
ServiceApiException Class
Autodesk.ModelDerivative.Model Namespace
BeginsWith Class
Between Class
Contains Class
DeleteManifest Class
DerivativeDownload Class
EqualsTo Class
GreaterThan Class
Job Class
JobAcceptedJobs Class
JobPayload Class
JobPayloadFormatAdvancedDWG Class
JobPayloadFormatAdvancedIFC Class
JobPayloadFormatAdvancedIGES Class
JobPayloadFormatAdvancedOBJ Class
JobPayloadFormatAdvancedOBJAdvanced Class
JobPayloadFormatAdvancedSTEP Class
JobPayloadFormatAdvancedSTL Class
JobPayloadFormatAdvancedSTLAdvanced Class
JobPayloadFormatAdvancedThumbnail Class
JobPayloadFormatDWG Class
JobPayloadFormatIFC Class
JobPayloadFormatIGES Class
JobPayloadFormatOBJ Class
JobPayloadFormatSTEP Class
JobPayloadFormatSTL Class
JobPayloadFormatSVF Class
JobPayloadFormatSVF2 Class
JobPayloadFormatSVF2AdvancedDGN Class
JobPayloadFormatSVF2AdvancedDWG Class
JobPayloadFormatSVF2AdvancedIFC Class
JobPayloadFormatSVF2AdvancedNWD Class
JobPayloadFormatSVF2AdvancedRVT Class
JobPayloadFormatSVF2AdvancedVUE Class
JobPayloadFormatSVFAdvancedDGN Class
JobPayloadFormatSVFAdvancedDWG Class
JobPayloadFormatSVFAdvancedIFC Class
JobPayloadFormatSVFAdvancedNWD Class
JobPayloadFormatSVFAdvancedRVT Class
JobPayloadFormatSVFAdvancedVUE Class
JobPayloadFormatThumbnail Class
JobPayloadInput Class
JobPayloadMisc Class
JobPayloadOutput Class
JobPayloadOutputDestination Class
LessThan Class
Manifest Class
ManifestDerivative Class
ManifestResources Class
MatchId Class
Messages Class
ModelViews Class
ModelViewsData Class
ModelViewsDataMetadata Class
ObjectTree Class
ObjectTreeData Class
ObjectTreeDataObjects Class
Properties Class
PropertiesData Class
PropertiesDataCollection Class
SpecificProperties Class
SpecificPropertiesPagination Class
SpecificPropertiesPayload Class
SpecificPropertiesPayloadPagination Class
SpecifyReferences Class
SpecifyReferencesPayload Class
SpecifyReferencesPayloadReferences Class
SupportedFormats Class
IJobPayloadFormat Interface
IJobPayloadFormatSVF2Advanced Interface
IJobPayloadFormatSVFAdvanced Interface
ISpecificPropertiesPayloadQuery Interface
ApplicationProtocol Enum
BuildingStoreys Enum
ConversionMethod Enum
ExportFileStructure Enum
ExtractorVersion Enum
Format Enum
Height Enum
Hierarchy Enum
MatchIdType Enum
MaterialMode Enum
Model2dView Enum
OpeningElements Enum
OutputType Enum
Payload Enum
Region Enum
Role Enum
SheetType Enum
SolidType Enum
Spaces Enum
SurfaceType Enum
Unit Enum
View Enum
Width Enum
XAdsDerivativeFormat Enum
XAdsJobStatus Enum
XAdsRole Enum
TypeScript SDK Reference
Classes
ModelDerivativeApiError
ModelDerivativeClient
Enumerations
ApplicationProtocol
BuildingStoreys
ConversionMethod
ExportFileStructure
ExtractorVersion
Format
Height
Hierarchy
MatchIdType
MaterialMode
Model2dView
OpeningElements
OutputType
Payload
Region
Role
SheetType
SolidType
Spaces
SurfaceType
Unit
View
Width
XAdsDerivativeFormat
XAdsJobStatus
XAdsRole
Interfaces
BeginsWith
Between
Contains
DeleteManifest
DerivativeDownload
EqualsTo
GreaterThan
Job
JobAcceptedJobs
JobPayload
JobPayloadFormat
JobPayloadFormatAdvancedDWG
JobPayloadFormatAdvancedIFC
JobPayloadFormatAdvancedIGES
JobPayloadFormatAdvancedOBJ
JobPayloadFormatAdvancedOBJAdvanced
JobPayloadFormatAdvancedSTEP
JobPayloadFormatAdvancedSTL
JobPayloadFormatAdvancedSTLAdvanced
JobPayloadFormatAdvancedThumbnail
JobPayloadFormatDWG
JobPayloadFormatIFC
JobPayloadFormatIGES
JobPayloadFormatOBJ
JobPayloadFormatSTEP
JobPayloadFormatSTL
JobPayloadFormatSVF
JobPayloadFormatSVF2
JobPayloadFormatSVF2Advanced
JobPayloadFormatSVF2AdvancedDGN
JobPayloadFormatSVF2AdvancedDWG
JobPayloadFormatSVF2AdvancedIFC
JobPayloadFormatSVF2AdvancedNWD
JobPayloadFormatSVF2AdvancedRVT
JobPayloadFormatSVF2AdvancedVUE
JobPayloadFormatSVFAdvancedDGN
JobPayloadFormatSVFAdvancedDWG
JobPayloadFormatSVFAdvancedIFC
JobPayloadFormatSVFAdvancedNWD
JobPayloadFormatSVFAdvancedRVT
JobPayloadFormatSVFAdvancedVUE
JobPayloadFormatThumbnail
JobPayloadInput
JobPayloadMisc
JobPayloadOutput
JobPayloadOutputDestination
LessThan
Manifest
ManifestDerivative
ManifestResources
MatchId
Messages
ModelViews
ModelViewsData
ModelViewsDataMetadata
ObjectTree
ObjectTreeData
ObjectTreeDataObjects
Properties
PropertiesData
PropertiesDataCollection
RequestArgs
RequiredError
SpecificProperties
SpecificPropertiesPagination
SpecificPropertiesPayload
SpecificPropertiesPayloadPagination
SpecifyReferences
SpecifyReferencesPayload
SpecifyReferencesPayloadReferences
SupportedFormats
Type-aliases
JobPayloadFormatSVFAdvanced
SpecificPropertiesPayloadQuery
Change History
REST API Changelog
.NET SDK Changelog
TypeScript SDK Changelog