openapi: 3.2.0
info:
  title: Autodesk Design Automation Work Items API
  description: The Design Automation API (formerly Automation API) enables running scripts and plugins on design files in the cloud using AutoCAD, Revit, Inventor, 3ds Max, and Fusion engines. It supports batch processing, parameter adjustment, drawing generation, and data extraction at enterprise scale without requiring local installations of desktop applications.
  version: 3.0.0
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/autodesk-web-services-api-terms-of-service
  contact:
    name: Autodesk Platform Services
    url: https://aps.autodesk.com
    email: aps.help@autodesk.com
  license:
    name: Autodesk API Terms of Service
    url: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/autodesk-web-services-api-terms-of-service
servers:
- url: https://developer.api.autodesk.com
  description: Production
security:
- OAuth2TwoLegged:
  - code:all
tags:
- name: Work Items
paths:
  /da/us-east/v3/workitems:
    post:
      operationId: createWorkItem
      summary: Autodesk Create WorkItem
      description: Creates and executes a WorkItem. A WorkItem is an instance of an Activity that processes specific input files and produces output files.
      tags:
      - Work Items
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkItemPayload'
      responses:
        '200':
          description: WorkItem created and queued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkItemStatus'
        '400':
          description: Bad request.
  /da/us-east/v3/workitems/{id}:
    get:
      operationId: getWorkItemStatus
      summary: Autodesk Get WorkItem Status
      description: Returns the status of a specific WorkItem.
      tags:
      - Work Items
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved WorkItem status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkItemStatus'
    delete:
      operationId: deleteWorkItem
      summary: Autodesk Cancel WorkItem
      description: Cancels a pending or running WorkItem.
      tags:
      - Work Items
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: WorkItem cancelled.
components:
  schemas:
    WorkItemArgument:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: URL to download input or upload output.
        verb:
          type: string
          enum:
          - get
          - put
          - post
          - patch
          - read
        headers:
          type: object
          additionalProperties:
            type: string
        localName:
          type: string
        pathInZip:
          type: string
        optional:
          type: boolean
    WorkItemPayload:
      type: object
      required:
      - activityId
      properties:
        activityId:
          type: string
          description: Fully qualified Activity ID (e.g., owner.activityname+alias).
        arguments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/WorkItemArgument'
        limitProcessingTimeSec:
          type: integer
          description: Processing time limit in seconds.
    WorkItemStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - pending
          - inprogress
          - success
          - failedDownload
          - failedInstructions
          - failedUpload
          - cancelled
          - failedLimitProcessingTime
          - failedLimitDataSize
        progress:
          type: string
        reportUrl:
          type: string
          format: uri
          description: URL to the processing report.
        stats:
          type: object
          properties:
            timeQueued:
              type: string
              format: date-time
            timeDownloadStarted:
              type: string
              format: date-time
            timeInstructionsStarted:
              type: string
              format: date-time
            timeInstructionsEnded:
              type: string
              format: date-time
            timeUploadEnded:
              type: string
              format: date-time
            bytesDownloaded:
              type: integer
            bytesUploaded:
              type: integer
        id:
          type: string
  securitySchemes:
    OAuth2TwoLegged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            code:all: Execute Design Automation activities