Autodesk Download Workflow API

Operations for downloading an object directly from S3 using signed URLs.

GitHub OpenAPI

Operations 1

GET /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signeds3download Generate Signed S3 Download URL #

Documentation

📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/overview/field-guide/issues/
📖
Documentation
https://aps.autodesk.com/developer/overview/autodesk-construction-cloud
📖
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/
📖
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/
📖
Documentation
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
Documentation
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
Documentation
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
Documentation
https://github.com/autodesk-platform-services/aps-sdk-openapi/tree/main/secureserviceaccount
📖
Documentation
https://aps.autodesk.com/en/docs/webhooks/v1/reference/

Specifications

SDKs

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-download-workflow-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-download-workflow-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: oss Download Workflow API
  version: '1.0'
  description: The Object Storage Service (OSS) allows your application to download and upload raw files (such as PDF, XLS, DWG, or RVT) that are managed by the Data service.
  contact:
    name: Autodesk Platform Services
    url: https://aps.autodesk.com/
    email: aps.help@autodesk.com
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service
  x-support: https://stackoverflow.com/questions/tagged/autodesk-data-management
servers:
- url: https://developer.api.autodesk.com
tags:
- name: Download Workflow
  description: Operations for downloading an object directly from S3 using signed URLs.
paths:
  /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signeds3download:
    get:
      tags:
      - Download Workflow
      summary: Generate Signed S3 Download URL
      description: 'Generates a signed URL to download an object directly from S3, bypassing OSS servers. This signed URL expires in 2 minutes by default, but you can change this duration if needed. You must start the download before the signed URL expires. The download itself can take longer. If the download fails after the validity period of the signed URL has elapsed, you can call this operation again to obtain a fresh signed URL.


        Additionally:


        - Range headers: You can use range headers with the signed download URL to download the object in chunks, enabling parallel downloads for better performance.

        - Multi-part objects: If the object was uploaded in chunks and is still assembling, you''ll receive multiple S3 URLs (one per chunk). To receive a single URL instead, set the ``public-resource-fallback`` query parameter to ``true``, which makes OSS return a single signed OSS URL while assembly is in progress.


        OSS offers two types of signed URLs:


        - S3 Signed URLs (the type generated by this operation): Enable direct S3 upload/download but are restricted to bucket owners only.

        - OSS Signed URLs: Also support upload/download operations and can be configured for access by other applications, making them ideal for sharing objects across different systems.


        **Important:** Only applications with read access to the object can call this operation.'
      operationId: signedS3Download
      parameters:
      - $ref: '#/components/parameters/bucketKey'
      - $ref: '#/components/parameters/objectKey'
      - name: x-ads-acm-scopes
        in: header
        description: Optional OSS-compliant scope reference to increase bucket search performance.
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: The last known ``sha1`` value of the object. OSS returns the signed URL only if the ``If-None-Match`` header differs from the ``sha1`` value of the object on S3. If not, it returns a 304 "Not Modified" HTTP status.
        schema:
          type: string
      - name: If-Modified-Since
        in: header
        description: A timestamp in the HTTP date format (Mon, DD Month YYYY HH:MM:SS GMT). The signed URL is returned only if the object has been modified since the specified timestamp. If not, a 304 (Not Modified) HTTP status is returned.
        schema:
          type: string
          format: date
      - name: response-content-type
        in: query
        description: The value of the Content-Type header you want to receive when you download the object using the signed URL. If you do not specify a value, the Content-Type header defaults to the value stored with OSS.
        schema:
          type: string
      - name: response-content-disposition
        in: query
        description: The value of the Content-Disposition header you want to receive when you download the object using the signed URL. If you do not specify a value, the Content-Disposition header defaults to the value stored with OSS.
        schema:
          type: string
      - name: response-cache-control
        in: query
        description: The value of the Cache-Control header you want to receive when you download the object using the signed URL. If you do not specify a value, the Cache-Control header defaults to the value stored with OSS.
        schema:
          type: string
      - name: public-resource-fallback
        in: query
        description: 'Determines how OSS returns the signed URLs when chunk assembly is not yet complete. Possible values:


          - ``true`` : Returns a single signed OSS URL.

          - ``false`` : (Default) Returns multiple signed S3 URLs, where each URL points to a chunk.

          '
        schema:
          type: boolean
      - name: minutesExpiration
        in: query
        description: 'The time window (in minutes) the signed URL will remain usable. Acceptable values = 1-60 minutes. Default = 2 minutes.


          **Tip:** Use the smallest possible time window to minimize exposure of the signed URL.

          '
        schema:
          type: integer
          minimum: 1
          maximum: 60
      - name: useCdn
        in: query
        description: 'Determines whether the generated signed URL should use a CloudFront edge location. Possible values:


          - ``true`` : Returns a URL that points to a CloudFront edge location.

          - ``false`` : (Default) Returns a URL that points directly to the S3 object.

          '
        schema:
          type: boolean
      responses:
        '200':
          description: The signed S3 download URL was successfully generated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SignedS3Download'
            application/json:
              examples:
                complete:
                  summary: Demonstrates the obtaining of an S3 signed URL for an object (raw uploads or merged resumable uploads) (200).
                  value:
                    status: complete
                    url: https://oss-bucket-name.s3.amazonaws.com/4F/2D/df/a9f898eda7edee1ab9827cfeb57f2ec647/apptestbucket?response-content-disposition=attachment%3B%20filename%3D%22objectKeyFoo%22&response-content-type=application%2Foctet-stream&X-Amz-Security-Token=AWS_TOKEN&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210120T152914Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=6c1abf52e7849asignature
                    params:
                      content-type: application/octet-stream
                      content-disposition: attachment; filename="objectKeyFoo"
                    size: 221983
                    sha1: 4F2Ddfa9f898eda7edee1ab9827cfeb57f2ec647
                fallback:
                  summary: Demonstrates the obtaining an OSS signed URL for an unmerged object because public-resource-fallback equals to true (200).
                  value:
                    status: fallback
                    url: http://developer.api.autodesk.com/oss/v2/signedresources/6969f2ed-2931-498f-bad8-b9d300ad1c7e?region=US
                    params:
                      content-type: application/json
                      content-disposition: attachment; filename="unmerged.json"
                    size: 19715187
                chunked:
                  summary: Demonstrates the obtaining of multiple S3 signed URLs for an unmerged object, one per chunk (200).
                  value:
                    status: chunked
                    urls:
                      0-10747471: https://oss-bucket.s3.amazonaws.com/ead4b508f5a502b9251d16b640128ad83af7e4ba/bucket/apptestbucket/chunk-uuid/uuid-fcdf6275-8789-472f-b811-5472c9262ffc?response-content-disposition=attachment%3B%20filename%3D%22unmerged.json%22&response-content-type=application%2Fjson&X-Amz-Security-Token=AWS_TOKEN&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210120T152914Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=6c1abf52e7849asignature
                      10747472-19715186: https://oss-bucket.s3.amazonaws.com/ead4b508f5a502b9251d16b640128ad83af7e4ba/bucket/apptestbucket/chunk-uuid/uuid-cc685997-7afa-4dd3-ada3-71390a973bc5?response-content-disposition=attachment%3B%20filename%3D%22unmerged.json%22&response-content-type=application%2Fjson&X-Amz-Security-Token=AWS_TOKEN&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210120T152914Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=6c1abf52e7849asignature
                    params:
                      content-type: application/json
                      content-disposition: attachment; filename="unmerged.json"
                    size: 19715187
                with-expiration:
                  summary: Demonstrates the obtaining of an S3 signed URL for an object using the minutesExpiration parameter (200).
                  value:
                    status: complete
                    url: https://oss-bucket-name.s3.amazonaws.com/4F/2D/df/a9f898eda7edee1ab9827cfeb57f2ec647/apptestbucket?response-content-disposition=attachment%3B%20filename%3D%22objectKeyFoo%22&response-content-type=application%2Foctet-stream&X-Amz-Security-Token=AWS_TOKEN&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210120T152914Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=6c1abf52e7849asignature
                    params:
                      content-type: application/octet-stream
                      content-disposition: attachment; filename="objectKeyFoo"
                    size: 221983
                    sha1: 4F2Ddfa9f898eda7edee1ab9827cfeb57f2ec647
              schema:
                $ref: '#/components/schemas/SignedS3Download'
        '304':
          description: The object has not been modified. OSS returns this response when the ``If-None-Match`` header matches the ``sha1`` value of the object on S3, or when the object has not been modified since the ``If-Modified-Since`` date.
          content: {}
        '400':
          description: The request could not be processed due to missing or malformed parameters.
          content: {}
        '401':
          description: Invalid authorization header.
          content: {}
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          description: The specified object or bucket does not exist.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:read
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/objects/objectKeyFoo/signeds3download" -X GET -H "Authorization: Bearer eYeL5gYxAT2j3u9TEerxoJoToNbi"'
components:
  responses:
    INTERNAL_SERVER_ERROR:
      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: {}
    FORBIDDEN:
      description: The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
      content: {}
  schemas:
    DownloadStatus:
      title: DownloadStatus
      x-stoplight:
        id: bufzykd0rpk39
      type: string
      description: 'Indicates the current state of the object requested for download. Possible values are:


        - ``complete`` - The object is ready to be downloaded.

        - ``chunked`` - The object was uploaded in chunks, but assembly of chunks into the final object is still pending. Returned when ``public-resource-fallback`` = ``false`` in the request.

        - ``fallback`` - The object was uploaded in chunks, but assembly of chunks into the final object is still pending. Will return an OSS Signed URL instead of a S3 signed URL because ``public-resource-fallback`` was set to ``true`` in the request.

        - ``skipped`` - The server has evaluated an ``If-None-Match`` or ``If-Modified-Since`` parameter in the request and determined that the cached version of the object is still up-to-date.

        - ``error`` - There was an error in the request. Review and verify the requested ``bucketKey``, ``content-type``, and ``content-disposition`` before you try again.

        '
      enum:
      - complete
      - chunked
      - fallback
      - skipped
      - error
    SignedS3Download:
      type: object
      description: An object representing the response payload on successful execution of a Generate Signed S3 Download URL operation.
      properties:
        status:
          $ref: '#/components/schemas/DownloadStatus'
        url:
          type: string
          description: A S3 signed URL with which to download the object. This attribute is returned when ``status`` is ``complete`` or ``fallback``; in the latter case, this will return an OSS signed URL, not an S3 signed URL.
        urls:
          type: object
          description: A map of S3 signed URLs, one for each chunk of an unmerged resumable upload. This attribute is returned when ``status`` is ``chunked``. The key of each entry is the byte range of the total file which the chunk comprises.
        params:
          type: object
          description: 'The values that were requested for the following parameters when requesting the S3 signed URL.


            - ``Content-Type``

            - ``Content-Disposition``

            - ``Cache-Control``.

            '
        size:
          type: integer
          format: int64
          description: The total amount of storage space occupied by the object, in bytes.
        sha1:
          type: string
          description: A hash value computed from the data of the object, if available.
      required:
      - status
      - params
      - size
  parameters:
    objectKey:
      name: objectKey
      in: path
      description: The URL-encoded human friendly name of the object.
      required: true
      schema:
        type: string
    bucketKey:
      name: bucketKey
      in: path
      description: The unique ID of the bucket that contains the objects you are operating on. ``bucketKey`` must be URL-encoded.
      required: true
      schema:
        pattern: ^[-_.a-z0-9]{3,128}$
        type: string
  securitySchemes:
    oauth2_application:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /authentication/v1/authenticate
          scopes:
            data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
            data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
            data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
            bucket:delete: The application will be able to delete an OSS bucket it will own.
            bucket:create: The application will be able to create an OSS bucket it will own.
            bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
            bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
      x-authentication_context: application context required
    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
            bucket:create: create an OSS bucket the application will own
            bucket:read: read the metadata and list contents for OSS buckets the application has access to
            bucket:update: set permissions and entitlements for OSS buckets the application has permission to modify
            bucket:delete: delete an OSS bucket the application owns
            viewables:read: read viewables of application accessible data
      x-authentication_context: application context required
      description: Application context required.
x-provenance:
  method: harvested
  publisher: Autodesk
  source: https://raw.githubusercontent.com/autodesk-platform-services/aps-sdk-openapi/main/oss/oss.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)