Autodesk Derivatives API

The Derivatives API from Autodesk — 1 operation(s) for derivatives.

GitHub OpenAPI

Operations 3

GET /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}/signedcookies Fetch Derivative Download URL #
HEAD /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn} Check Derivative Details #
GET /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn} Autodesk Download Derivative #

Documentation

📖
Documentation
https://aps.autodesk.com/developer/overview/authentication-api
📖
APIReference
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
GettingStarted
https://aps.autodesk.com/en/docs/oauth/v2/tutorials
📖
Documentation
https://aps.autodesk.com/developer/overview/data-management-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/model-derivative-api
📖
APIReference
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/model-derivative/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/automation-api
📖
Documentation
https://aps.autodesk.com/webhooks-api
📖
APIReference
https://aps.autodesk.com/en/docs/webhooks/v1/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/webhooks/v1/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/reality-capture-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/reality-capture/v1/tutorials/create-3d-mesh-from-photos/
📖
Documentation
https://aps.autodesk.com/developer/overview/sustainability-data-api
📖
APIReference
https://aps.autodesk.com/en/docs/sustainability/v3/reference/http/
📖
GettingStarted
https://aps.autodesk.com/en/docs/sustainability/v3/tutorials/tutorial_01/
📖
Documentation
https://aps.autodesk.com/developer/overview/parameters-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/parameters/v1/tutorials/getting-started/
📖
Documentation
https://aps.autodesk.com/developer/overview/tandem-data-api
📖
Documentation
https://aps.autodesk.com/developer/overview/flow-graph-engine-api
📖
APIReference
https://aps.autodesk.com/en/docs/flow_graph_engine/v1/reference/quick_reference/
📖
Documentation
https://aps.autodesk.com/developer/overview/autodesk-construction-cloud
📖
GettingStarted
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
APIReference
https://aps.autodesk.com/en/docs/acc/v1/reference
📖
Documentation
https://aps.autodesk.com/developer/overview/bim-360-api
📖
APIReference
https://aps.autodesk.com/en/docs/bim360/v1/reference/

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autodesk:autodesk-derivatives-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autodesk-derivatives-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Autodesk Derivatives API
  x-refined-note:
  - x-support differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Derivatives across 2 of this provider''s published API definitions: aps-sdk-openapi-modelderivative-modelderivative.yaml, autodesk-model-derivative-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://developer.api.autodesk.com
- url: https://developer.api.autodesk.com/regions/eu
  description: Production (EMEA)
tags:
- name: Derivatives
paths:
  /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}/signedcookies:
    parameters:
    - name: derivativeUrn
      in: path
      schema:
        type: string
      description: The URL-encoded URN of the derivative. Use the `Fetch Manifest operation </en/docs/model-derivative/v2/reference/http/manifest/urn-manifest-GET/>`_ to obtain the URNs of derivatives for the specified source design.
      required: true
    - $ref: '#/components/parameters/source-design-urn'
    get:
      summary: Fetch Derivative Download URL
      tags:
      - Derivatives
      responses:
        '200':
          description: The download URL of the specified derivative was successfully retrieved.
          headers:
            Content-Type:
              schema:
                type: string
              description: application/octet-stream
            Content-Length:
              schema:
                type: string
              description: Denotes the size of the derivative, in bytes.
            x-ads-app-identifier:
              $ref: '#/components/headers/x-ads-app-identifier'
            x-ads-startup-time:
              $ref: '#/components/headers/x-ads-startup-time'
            x-ads-duration:
              $ref: '#/components/headers/x-ads-duration'
            Set-Cookie:
              schema:
                type: string
              description: Signed cookie to use with download URL. There will be three headers in the response named Set-Cookie
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DerivativeDownload'
        '400':
          $ref: '#/components/responses/400-general'
        '401':
          $ref: '#/components/responses/401-general'
        '403':
          $ref: '#/components/responses/403-general'
        '404':
          $ref: '#/components/responses/404-general'
        '500':
          $ref: '#/components/responses/500-general'
      operationId: getDerivativeUrl
      description: Retrieves a download URL and a set of signed cookies that let you securely download the derivative specified by the ``derivativeUrn`` URI parameter. The signed cookies have a lifetime of 6 hours. You can use range headers with the returned download URL to download the derivative in chunks, in parallel.
      parameters:
      - schema:
          type: integer
        in: query
        name: minutes-expiration
        description: Specifies how many minutes the signed cookies should remain valid. Default value is 360 minutes. The value you specify must be lower than the default value for this parameter. If you specify a value greater than the default value, the Model Derivative service will return an error with an HTTP status code of ``400``.
      - schema:
          type: string
        in: query
        name: response-content-disposition
        description: The value that must be specified as the ``response-content-disposition`` query string parameter with the download URL. Must begin with ``attachment``. This value defaults to the default value corresponding to the derivative/file.
      - $ref: '#/components/parameters/region'
      security:
      - 2-legged:
        - data:read
      - 3-legged:
        - data:read
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtMjIwNTIwL2JveC5pcHQ/manifest/urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtMjIwNTIwL2JveC5pcHQ/output/225ba6fd-8516-460d-bb34-8bc85c09a79d/box.obj/signedcookies" -X GET -H "Authorization: Bearer eyJh..."'
    servers:
    - url: https://developer.api.autodesk.com
  /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}:
    parameters:
    - $ref: '#/components/parameters/source-design-urn'
    - name: derivativeUrn
      in: path
      schema:
        type: string
      description: The URL-encoded URN of the derivative. Check the manifest of the source design to get the URNs of the derivatives available for download.
      required: true
    head:
      summary: Check Derivative Details
      tags:
      - Derivatives
      responses:
        '200':
          description: Information about the specified derivative was successfully retrieved.
          headers:
            Content-Type:
              schema:
                type: string
              description: application/octet-stream
            Content-Length:
              schema:
                type: string
              description: Denotes the size of the specified derivative, in bytes.
            x-ads-app-identifier:
              $ref: '#/components/headers/x-ads-app-identifier'
            x-ads-startup-time:
              $ref: '#/components/headers/x-ads-startup-time'
            x-ads-duration:
              $ref: '#/components/headers/x-ads-duration'
            x-ads-troubleshooting:
              $ref: '#/components/headers/x-ads-troubleshooting'
        '202':
          description: The request was accepted but processing is not complete. Repeat the request until you receive an HTTP status of ``200``.
        '400':
          $ref: '#/components/responses/400-general'
        '401':
          $ref: '#/components/responses/401-general'
        '403':
          $ref: '#/components/responses/403-general'
        '404':
          $ref: '#/components/responses/404-general'
        '500':
          $ref: '#/components/responses/500-general'
      operationId: headCheckDerivative
      description: 'Retrieves information about the specified derivative.


        Use this operation to determine the total content length of a derivative before you download it. If the derivative is large, you can choose to download the derivative in chunks, by specifying a chunk size using the ``Range`` header parameter.'
      parameters:
      - $ref: '#/components/parameters/region'
      security:
      - 2-legged:
        - data:read
      - 3-legged:
        - data:read
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest/urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf" -X HEAD -H "Authorization: Bearer eyJh..."'
    get:
      operationId: getDerivativeDownload
      summary: Autodesk Download Derivative
      description: Downloads a specific derivative file.
      tags:
      - Derivatives
      parameters:
      - name: urn
        in: path
        required: true
        schema:
          type: string
      - name: derivativeUrn
        in: path
        required: true
        description: URL-encoded URN of the derivative.
        schema:
          type: string
      responses:
        '200':
          description: Successfully downloaded derivative.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Derivative not found.
      security:
      - 2-legged:
        - data:read
        - data:write
      - 3-legged:
        - data:read
        - data:write
    servers:
    - url: https://developer.api.autodesk.com
components:
  schemas:
    Diagnostic:
      type: object
      title: Diagnostic
      description: Contains information about why the request failed.
      properties:
        diagnostics:
          type: string
          description: A detailed description of the error, which can help you troubleshoot the issue.
    DerivativeDownload:
      title: DerivativeDownload
      type: object
      description: Represents the successful response of a Fetch Derivative Download operation.
      properties:
        etag:
          type: string
          description: The calculated ETag hash of the derivative/file, if available.
        size:
          type: number
          description: The size of the derivative/file, in bytes.
        url:
          type: string
          description: The download URL.
        content-type:
          type: string
          description: The content type of the derivative/file.
        expiration:
          type: number
          description: The 13-digit epoch time stamp indicating the time the signed cookies expire.
    Region:
      type: string
      description: 'Specifies where the referenced files are stored. Possible values:


        - ``US`` - Data center for the US region.

        - ``EMEA`` - Data center for the European Union, Middle East, and Africa.

        - ``AUS`` - Data center for the Australia region.

        - ``CAN`` - Data center for the Canada region.

        - ``DEU`` - Data center for the Germany region.

        - ``IND`` - Data center for the India region.

        - ``JPN`` - Data center for the Japan region.

        - ``GBR`` - Data center for the United Kingdom region.

        '
      enum:
      - US
      - EMEA
      - AUS
      - CAN
      - DEU
      - IND
      - JPN
      - GBR
  headers:
    x-ads-startup-time:
      description: 'The service startup time, in the following date format: ``EEE MMM dd HH:mm:ss Z yyyy``.'
      schema:
        type: string
    x-ads-app-identifier:
      description: The service identifier. Comprises of the service name, version, and environment.
      schema:
        type: string
    x-ads-duration:
      description: The amount of time spent servicing the request, in milliseconds.
      schema:
        type: string
    x-ads-troubleshooting:
      description: Provides information about server failures, if any.
      schema:
        type: string
  responses:
    404-general:
      description: The requested resource was not found. Review the request and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Diagnostic'
    403-general:
      description: The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Diagnostic'
    400-general:
      description: The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Diagnostic'
    500-general:
      description: An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Diagnostic'
    401-general:
      description: The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Diagnostic'
  parameters:
    source-design-urn:
      name: urn
      in: path
      schema:
        type: string
      description: The URL-safe Base64 encoded URN of the source design. This value is used as the ``urn`` URI parameter in operations to access data for this source design.
      required: true
    region:
      name: region
      in: header
      schema:
        $ref: '#/components/schemas/Region'
      description: "Specifies the data center where the manifest and derivatives of the specified source design are stored. Possible values are:\n\n- ``US`` - (Default) Data center for the US region.\n- ``EMEA`` - Data center for the European Union, Middle East, and Africa. \n- ``AUS`` - Data center for the Australia region.\n- ``CAN`` - Data center for the Canada region.\n- ``DEU`` - Data center for the Germany region.\n- ``IND`` - Data center for the India region.\n- ``JPN`` - Data center for the Japan region.\n- ``GBR``  - Data center for the United Kingdom region.\n"
  securitySchemes:
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          refreshUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read your data
            data:write: modify your data
            data:create: create new data
      x-authentication_context: user context required
      description: User context required.
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read application accessible data
            data:write: write application accessible data
            data:create: create application accessible data
      x-authentication_context: application context required
      description: Application context required.
    OAuth2TwoLegged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: Read access to data
            data:write: Write access to data
            data:create: Create new data
    OAuth2ThreeLegged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: Read access to data
            data:write: Write access to data
            data:create: Create new data
x-refined-from:
- aps-sdk-openapi-modelderivative-modelderivative.yaml
- autodesk-model-derivative-openapi.yml
x-stoplight:
  id: a5p3h5029y9kz