Initializes new client with specific authentication method.
Authentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Optional
host: stringForge API host.
Optional
region: RegionForge availability region.
Protected
Optional
authProtected
axiosProtected
hostProtected
regionProtected
rootProtected
Optional
tokenProtected
deleteDeletes manifest (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-DELETE|docs).
Document derivative URN.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
fetchGets a list of supported translation formats (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/formats-GET|docs).
Dictionary of all supported output formats mapped to arrays of formats these outputs can be obtained from.
Error when the request fails, for example, due to insufficient rights.
Protected
getProtected
getDownloads content of a specific model derivative (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs).
Model URN.
Derivative URN.
Derivative content.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Downloads content of a specific model derivative asset in chunks (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs).
Model URN.
Derivative URN.
Optional
maxChunkSize: number = ...Maximum size (in bytes) of a single downloaded chunk.
Readable stream with the content of the downloaded derivative asset.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
getDownloads content of a specific model derivative (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs).
Model URN.
Derivative URN.
Derivative content stream.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Retrieves manifest of a derivative (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-GET|docs).
Document derivative URN.
Document derivative manifest.
Error when the request fails, for example, due to insufficient rights.
Retrieves metadata of a derivative (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-GET|docs).
Document derivative URN.
Document derivative metadata.
Error when the request fails, for example, due to insufficient rights.
Retrieves metadata of a derivative as a readable stream (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-GET|docs).
Document derivative URN.
Document derivative metadata.
Error when the request fails, for example, due to insufficient rights.
Protected
getRetrieves derivative thumbnail (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-thumbnail-GET|docs).
Document derivative URN.
Optional
size: ThumbnailSize = ThumbnailSize.MediumThumbnail size (small: 100x100 px, medium: 200x200 px, or large: 400x400 px).
Thumbnail data.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Retrieves derivative thumbnail stream (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-thumbnail-GET|docs).
Document derivative URN.
Optional
size: ThumbnailSize = ThumbnailSize.MediumThumbnail size (small: 100x100 px, medium: 200x200 px, or large: 400x400 px).
Thumbnail data stream.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Private
getRetrieves properties of a specific viewable (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-properties-GET|docs).
Document derivative URN.
Viewable GUID.
Optional
force: booleanForce query even when exceeding the size limit (20MB).
Optional
objectId: numberThe Object ID of the object you want to query properties for.
If objectid
is omitted, the server returns properties for all objects.
Optional
retryOn202: boolean = trueKeep repeating the request while the response status is 202 (indicating that the resource is being prepared).
Viewable properties.
Error when the request fails, for example, due to insufficient rights.
Retrieves properties of a specific viewable as a readable stream (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-properties-GET|docs).
Document derivative URN.
Viewable GUID.
Optional
force: booleanForce query even when exceeding the size limit (20MB).
Optional
objectId: numberThe Object ID of the object you want to query properties for.
If objectid
is omitted, the server returns properties for all objects.
Optional
retryOn202: boolean = trueKeep repeating the request while the response status is 202 (indicating that the resource is being prepared).
Readable stream.
Error when the request fails, for example, due to insufficient rights.
Retrieves object tree of a specific viewable (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-GET|docs).
Document derivative URN.
Viewable GUID.
Optional
force: booleanForce query even when exceeding the size limit (20MB).
Optional
objectId: numberIf specified, retrieves the sub-tree that has the specified object ID as its parent node. If this parameter is not specified, retrieves the entire object tree.
Optional
retryOn202: boolean = trueKeep repeating the request while the response status is 202 (indicating that the resource is being prepared).
Optional
includeLevel1: booleanIf true, grabs only the first level from the specified objectId. ObjectId must be provided.
Viewable object tree.
Error when the request fails, for example, due to insufficient rights.
Retrieves object tree of a specific viewable as a readable stream (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-GET|docs).
Document derivative URN.
Viewable GUID.
Optional
force: booleanForce query even when exceeding the size limit (20MB).
Optional
objectId: numberIf specified, retrieves the sub-tree that has the specified object ID as its parent node. If this parameter is not specified, retrieves the entire object tree.
Optional
retryOn202: boolean = trueKeep repeating the request while the response status is 202 (indicating that the resource is being prepared).
Readable stream.
Error when the request fails, for example, due to insufficient rights.
Protected
patchProtected
postProtected
putResets client to specific authentication method, Forge host, and availability region.
Optional
auth: IAuthOptionsAuthentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Optional
host: stringForge API host.
Optional
region: RegionForge availability region ("US" or "EMEA").
Protected
setSubmits a translation job (https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/job-POST|docs).
Document to be translated.
List of requested output formats.
Optional
pathInArchive: stringOptional relative path to root design if the translated file is an archive.
Optional
force: booleanForce translation even if a derivative already exists.
Optional
workflowId: stringOptional workflow ID to be used with Forge Webhooks.
Optional
workflowAttr: objectOptional workflow attributes to be used with Forge Webhooks.
Translation job details, with properties 'result', 'urn', and 'acceptedJobs'.
Error when the request fails, for example, due to insufficient rights.
Generated using TypeDoc
Client providing access to Autodesk Forge derivative APIs.
Tutorial
model-derivative